On Sat, Feb 08, 2020 at 01:37:00PM -0800, Kyle Isom wrote: > On Fri, Feb 7, 2020, at 23:22, Jason McIntyre wrote: > > if we do reference these config files from the man pages, i guess that > > should be correctly done from a FILES section, since EXAMPLES is really > > showing how to use the tool, rather than how to configure it. it is a > > fine line though. > > > > i wouldn;t be against adding to FILES - it'd be very brief, make sense, > > and provide the reminder being asked for. > > I got the EXAMPLES part from httpd.conf(5). If you think the note should > still be added there, I'm happy to do that. In the case where following the > style of httpd.conf(5) is okay, here's an updated diff, though it's hard to > tell from this thread if it's wanted. > > > - kyle > > > Index: sbin/dhclient/dhclient.conf.5 > =================================================================== > RCS file: /cvs/src/sbin/dhclient/dhclient.conf.5,v > retrieving revision 1.49 > diff -u -p -u -p -r1.49 dhclient.conf.5 > --- sbin/dhclient/dhclient.conf.5 17 Dec 2019 14:21:54 -0000 1.49 > +++ sbin/dhclient/dhclient.conf.5 8 Feb 2020 21:31:05 -0000 > @@ -288,6 +288,11 @@ instead of the > .Ic sname > field of the DHCP offer when binding a lease. > .El > +.Sh EXAMPLES > +An example configuration for > +.Pa dhclient.conf > +is provided in > +.Pa /etc/examples/dhclient.conf . > .Sh SEE ALSO > .Xr dhclient.leases 5 , > .Xr dhcp-options 5 , >
in my opinion, i'm definitely against this type of addition: it adds an EXAMPLES section, without providing any examples. - i'm ok with adding the path to these files to a FILES section - i'm ok with afterboot.8 mentioning /etc/examples - i recognise that there may be some cases where EXAMPLES points to the example config. it possibly makes sense for httpd.conf. i don;t think it makes sense for dhclient.conf. jmc
