Differential D23814

netgraph.h: Wrong path in the man page
ClosedPublic
Actions

Authored by donner on Feb 24 2020, 11:09 AM.

Details

Reviewers

bcr

Group Reviewers

manpages

Commits

rS361074: Fix SYNPOSIS section to point to the proper include directive.

Summary

netgraph(3) points to #include <netgraph/netgraph.h>, which is kernel only.
The man page refers to the user-space part of the netgraph module, which is located in <netgraph.h>.

Test Plan

#include <netgraph/netgraph.h>

compile as use space program will produce the error message

/usr/include/netgraph/netgraph.h:48:2: error: "This file should not be included in user level programs"

Change it to

#include <netgraph.h>

and it compiles fine.

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

No Lint Coverage

Unit

No Test Coverage

Build Status

Buildable 29567
Build 27428: arc lint + arc unit

Event Timeline

donner created this revision.Feb 24 2020, 11:09 AM

Herald added a reviewer: manpages. · View Herald TranscriptFeb 24 2020, 11:09 AM

Herald added subscribers: Contributor Reviews (src), imp. · View Herald Transcript

Harbormaster completed remote builds in B29567: Diff 68746.Feb 24 2020, 11:09 AM

Good catch, I'll commit the fix.
Thank you!

This revision is now accepted and ready to land.May 15 2020, 11:57 AM

Closed by commit rS361074: Fix SYNPOSIS section to point to the proper include directive. (authored by bcr). · Explain WhyMay 15 2020, 12:04 PM

This revision was automatically updated to reflect the committed changes.

bcr added a commit: rS361074: Fix SYNPOSIS section to point to the proper include directive..

Revision Contents
Changeset List

Path

Size

lib/

libnetgraph/

netgraph.3

4 lines

Diff 68746

View Options

lib/libnetgraph/netgraph.3

netgraph.h: Wrong path in the man pageClosedPublicActions