From f0fcc4cbce724bd11bf1462ba83f635ab12576f0 Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Tue, 20 Dec 2005 09:42:49 +0000 Subject: [PATCH] Minor changes --- HOWTOHELP | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/HOWTOHELP b/HOWTOHELP index dd7ce8bb9..105493640 100644 --- a/HOWTOHELP +++ b/HOWTOHELP @@ -21,7 +21,12 @@ You can help in the following ways: -- writing new pages (see below for a list of currently missing pages); -- grepping for the string FIXME in existing pages and writing a - suitable patch (see below); and + suitable patch (see below); + +-- asking me to add you to my distribution list for notification of + new man-pages releases, and reviewing the changes that have + occurred during a release (do "diff -ruN" between the directory + trees for the current and previous releases); and -- suggesting improvements to this document. @@ -43,10 +48,10 @@ When you submit a patch, please note the following: or mirrors: ftp://ftp.XX.kernel.org/pub/linux/docs/manpages -- Let me know how you obtained the information: was it by reading (or - writing) the relevant kernel or (g)libc source code; by writing a test - program (send it to me, if you want, and if it is clear and simple - to use); from other documentation; from a mailing list or Usenet - thread (please provide a URL if possible). + writing) the relevant kernel or (g)libc source code; by writing a + test program (send it to me, if you want, and if it is clear and + simple to use); from other documentation; from a mailing list or + Usenet thread (please provide a URL if possible). -- Send patches in "diff -u" format, inline inside the mail message is usually best; if it is a very long patch then send it both inline @@ -71,12 +76,13 @@ When you submit a patch, please note the following: MANUAL PAGES IN OTHER PACKAGES ============================== -Not all Linux manual pages are part of the man-pages set. In particular, -most Section 1 and 8 pages come as part of some other package. -The easiest way to determine which pages are part of the man-pages package -is to download the latest tarball, and see if the page is present. +Not all Linux manual pages are part of the man-pages set. In +particular, most Section 1 and 8 pages come as part of some other +package. The easiest way to determine which pages are part of the +man-pages package is to download the latest tarball, and see if the +page is present. -If you want to submit a patch for a manual page that comes from another +If you want to submit a patch for a manual page that comes from another source, then you need to work out where the manual page comes from (i.e., which package) and who the maintainer of that manual page is. @@ -97,8 +103,8 @@ package, we see: Maintainer of getopt: Frodo Looijaard Maintainer of simpleinit: Richard Gooch -On a Debian-based distribution (e.g. Debian, Knoppix, Ubuntu) you can do -the following: +On a Debian-based distribution (e.g. Debian, Knoppix, Ubuntu) you can +do the following: $ man -w fstab /usr/share/man/man5/fstab.5.gz @@ -108,10 +114,9 @@ the following: Maintainer: LaMont Jones Note: this gives you the Debian maintainer of the package in question, -which is a good address to report to, since many packages and manual pages -are modified by Debian. -The maintainer of the original package can -usually be found in a README in /usr/share/doc/. +which is a good address to report to, since many packages and manual +pages are modified by Debian. The maintainer of the original package +can usually be found in a README in /usr/share/doc/. Use "dpkg -L mount" to find all files from the mount package. (FIXME: add instructions for doing the equivalent of the above on