On Sun, Feb 09, 2020 at 12:41:43AM +0100, Sebastian Benoit wrote:
> Ingo Schwarze(schwa...@usta.de) on 2020.02.09 00:33:06 +0100:
> > Hi,
> > 
> > Jason McIntyre wrote on Sat, Feb 08, 2020 at 10:15:08PM +0000:
> > 
> > > - i'm ok with adding the path to these files to a FILES section
> > 
> > So, here is a specific patch for bgpf.conf(5) and bgpd(8) such
> > that we can agree on a general direction for one case where
> > the example file is particularly important.
> > 
> > Once the direction is agreed, applying it to the relatively
> > small number of other cases is likely not difficult.
> > 
> > OK?
> >   Ingo
> 
> I'm not against this as it only adds to the manpage, but an
> alternative could be to just tell users (in afterboot(8)?) that there is
> /etc/examples for them to look at and see whats there?
> 
> Otherwise ok.

I still think it's a good idea to put it in afterboot(8).
That was the patch I sent to a few people that obviously triggered Ingo.

As for /etc/examples, I still think that directory has merits.
It's WAY easier to copy an example file and uncomment/tweak the parts you
need while skimming through the manpage than creating one from scratch.

Also, cut&paste from an EXAMPLE in the manpage is distasteful.

Yeah, it's more info that has to be kept in synch. So what ? It's still
useful, so it should stay.

Here's an updated version, taking Theo's remarks into account.

Index: afterboot.8
===================================================================
RCS file: /cvs/src/share/man/man8/afterboot.8,v
retrieving revision 1.164
diff -u -p -r1.164 afterboot.8
--- afterboot.8 28 Sep 2018 18:21:31 -0000      1.164
+++ afterboot.8 9 Feb 2020 13:26:29 -0000
@@ -60,6 +60,10 @@ command, type:
 Administrators will rapidly become more familiar with
 .Ox
 if they get used to using the high quality manual pages.
+.Pp
+Some base programs and subsystems also come with sample configuration 
+files in
+.Pa /etc/examples .
 .Ss Errata
 By the time that you have installed your system, it is possible that
 bugs in the release have been found.

Reply via email to