Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 4 Sep 2001 08:02:24 -0700
From:      Kris Kennaway <kris@obsecurity.org>
To:        Ruslan Ermilov <ru@FreeBSD.org>
Cc:        Valentino Vaschetto <logo@FreeBSD.org>, cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org
Subject:   Re: cvs commit: src/share/man/man9 mutex.9
Message-ID:  <20010904080224.B48220@xor.obsecurity.org>
In-Reply-To: <20010904131644.B54480@sunbay.com>; from ru@FreeBSD.org on Tue, Sep 04, 2001 at 01:16:44PM %2B0300
References:  <200109020045.f820jfL13842@freefall.freebsd.org> <20010904131644.B54480@sunbay.com>

next in thread | previous in thread | raw e-mail | index | archive | help

--3uo+9/B/ebqu+fSQ
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Tue, Sep 04, 2001 at 01:16:44PM +0300, Ruslan Ermilov wrote:
> On Sat, Sep 01, 2001 at 05:45:41PM -0700, Valentino Vaschetto wrote:
> > logo        2001/09/01 17:45:41 PDT
> >=20
> >   Modified files:
> >     share/man/man9       mutex.9=20
> >   Log:
> >   From Mike Silbersack's message on cvs-commits:
> >  =20
> >   > > Doh!  There is a sx man page, the mutex man page just doesn't hav=
e a SEE
> >   > > ALSO pointing to sx(9).  Could some mdoc madman go add one?
> >  =20
> >   Revision  Changes    Path
> >   1.19      +5 -1      src/share/man/man9/mutex.9
> >=20
> Hey, you've just got a yellow card for this commit!
>=20
> 1)  Don't insert extra whitespace at EOL.
> 2)  Don't put the garbage.
> 3)  Check the stderr output with ``groff -ww -Tascii -mtty-char -man''

Where are #1 and #3 documented?

I'm somewhat intimidated by all of these manpage style rules which are
being enforced thesedays.  Even if these are documented clearly
somewhere (which I don't think they are) you shouldn't be too hard on
committers who don't understand the arcane world of mdoc, and either
just commit a cleanup after the changes have been made, or ask
everyone to commit through you or someone else who understands the
rules (I prefer the first alternative).

Remember, the goal of manpages is to have good documentation, not
necessarily style-perfect documentation.

Kris

--3uo+9/B/ebqu+fSQ
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (FreeBSD)
Comment: For info see http://www.gnupg.org

iD8DBQE7lO0AWry0BWjoQKURAs0FAJ4wpUxUgLtMgko0FeIxEumVCnpRBwCeJmjX
hvGnxLoHaPEFC/8tQqA1a0U=
=le/D
-----END PGP SIGNATURE-----

--3uo+9/B/ebqu+fSQ--

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010904080224.B48220>