Re: Getting rid of standard boiler plate in kernel man pages CODE REFERENCES
Hi Iain! I'm not sure what you are proposing.. can you show an example diff (eg using bluetooth.9) ? Sure, attached. Thomas Index: bluetooth.9 === RCS file: /cvsroot/src/share/man/man9/bluetooth.9,v retrieving revision 1.4 diff -u -r1.4 bluetooth.9 --- bluetooth.9 2 Dec 2007 20:03:11 - 1.4 +++ bluetooth.9 8 Nov 2010 09:33:42 - @@ -348,13 +348,6 @@ .Ar ref . .El .Sh CODE REFERENCES -This section describes places in the -.Nx -source tree where actual code implementing or using the -Bluetooth Protocol Stack can be found. -All pathnames are relative to -.Pa /usr/src . -.Pp The Bluetooth Protocol Stack is contained in the .Pa sys/netbt directory. Index: intro.9 === RCS file: /cvsroot/src/share/man/man9/intro.9,v retrieving revision 1.13 diff -u -r1.13 intro.9 --- intro.9 15 Apr 2010 08:40:46 - 1.13 +++ intro.9 8 Nov 2010 09:33:42 - @@ -45,6 +45,8 @@ .It CODE REFERENCES Contains the pathname(s) of the source file(s) which contain the definition and/or source code of the variables or functions being documented. +Any paths are relative to +.Pa /usr/src . .El .Sh MEMORY MANAGEMENT Machine-dependent swap interface.
Re: Getting rid of standard boiler plate in kernel man pages CODE REFERENCES
On Mon, 8 Nov 2010, David Holland wrote: Not from me! Although rather than /usr/src it might say the top level of the source tree. How about: [...] +Any paths are relative to the top level of the source tree (usually +.Pa /usr/src ) . Sounds fine. Or perhaps historically instead of usually :) Or often might work, too. No opinion on that :-) typically or frequently are two additional possibilities! - | Paul Goyette | PGP Key fingerprint: | E-mail addresses: | | Customer Service | FA29 0E3B 35AF E8AE 6651 | paul at whooppee.com| | Network Engineer | 0786 F758 55DE 53BA 7731 | pgoyette at juniper.net | | Kernel Developer | | pgoyette at netbsd.org | -
Re: Getting rid of standard boiler plate in kernel man pages CODE REFERENCES
Thomas Klausner w...@netbsd.org wrote: Many many many kernel (section 9) man pages contain the following sentence in their CODE REFERENCES section: This section describes places within the .Nx source tree where actual code implementing .Nm can be found. All pathnames are relative to .Pa /usr/src . .Pp I suggest we remove it and adapt the DESCRIPTION section in intro(9) to mention that the pathnames are relative to /usr/src. Seems reasonable to me. Thanks. -- Mindaugas
Re: Getting rid of standard boiler plate in kernel man pages CODE REFERENCES
Paul Goyette p...@whooppee.com wrote: How about: [...] +Any paths are relative to the top level of the source tree (usually +.Pa /usr/src ) . Sounds fine. Or perhaps historically instead of usually :) Or often might work, too. No opinion on that :-) typically or frequently are two additional possibilities! And traditionally. :) -- Mindaugas
Getting rid of standard boiler plate in kernel man pages CODE REFERENCES
Hi! Many many many kernel (section 9) man pages contain the following sentence in their CODE REFERENCES section: This section describes places within the .Nx source tree where actual code implementing .Nm can be found. All pathnames are relative to .Pa /usr/src . .Pp I suggest we remove it and adapt the DESCRIPTION section in intro(9) to mention that the pathnames are relative to /usr/src. Any disagreement? Thomas
