Date: Wed, 7 Dec 2011 14:59:50 -0600 From: Brooks Davis <brooks@freebsd.org> To: Frank Leonhardt <freebsd-doc@fjl.co.uk> Cc: freebsd-doc@freebsd.org Subject: Re: The state of some of the man pages Message-ID: <20111207205950.GA50134@lor.one-eyed-alien.net> In-Reply-To: <4EDFCB27.3030803@fjl.co.uk> References: <4EDFCB27.3030803@fjl.co.uk>
next in thread | previous in thread | raw e-mail | index | archive | help
--huq684BweRXVnRxX Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Wed, Dec 07, 2011 at 08:23:03PM +0000, Frank Leonhardt wrote: > I've been moved to join this list because some of the man pages are=20 > driving me crazy; they're out of date. >=20 > Fortunately I speak fluent 'C', so I often end up diving into the source= =20 > code in order to find out what's really going on. But I'm currently in=20 > the mood to do something more positive about it. >=20 > But how? >=20 > I'm not talking about fixing typos here; I'm referring to large chunks=20 > of information that are simply missing. For example, 'top' does so much= =20 > more than the current documentation suggests. >=20 > If someone would be good enough to tell me how, I'm volunteering to=20 > update the man pages as I go. >=20 > For the avoidance of doubt, I don't want to know how to create a man=20 > page, I want to know how to submit updated man pages for eventual=20 > inclusion in the next release. The process is quite simple. Just make the changes and then submit bug reports containing unified diffs of the changes in using send-pr(1). If the program or API has been changed recently you might send a copy of the PR to the person who made the change since they will likely be happy to stop feeling guilty about not documenting it in the first place. You might also ask on freebsd-doc if you don't get a fairly quick response and someone there can help (src committers can too, but you may get better review from doc committers). If you submit too many of them you will likely end up being offered a commit bit to save the poor doc committer some work. -- Brooks --huq684BweRXVnRxX Content-Type: application/pgp-signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.11 (FreeBSD) iD8DBQFO39PGXY6L6fI4GtQRAldjAJ9CZimq4im7YTGgqOKC4JKXSsSM/QCfYBfb NGhxzozf7txHiKk15ebQPeA= =W5dS -----END PGP SIGNATURE----- --huq684BweRXVnRxX--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20111207205950.GA50134>