Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 24 Nov 2014 16:33:58 +0100
From:      "Ronald Klop" <ronald-lists@klop.ws>
To:        "Baptiste Daroussin" <bapt@freebsd.org>
Cc:        svn-src-head@freebsd.org, svn-src-all@freebsd.org, src-committers@freebsd.org, Joel Dahl <joel@vnode.se>
Subject:   Re: svn commit: r274925 - in head: lib/libc/sys lib/libdpv sbin/ipfw share/man/man4 share/man/man4/man4.arm share/man/man9 sys/boot/common sys/boot/i386/gptzfsboot usr.bin/dpv
Message-ID:  <op.xpt5iwwpkndu52@ronaldradial.radialsg.local>
In-Reply-To: <20141124093813.GL68776@ivaldir.etoilebsd.net>
References:  <201411232100.sANL00cG078781@svn.freebsd.org> <20141123210412.GG68776@ivaldir.etoilebsd.net> <20141124072316.GA27782@ymer.vnode.se> <op.xptn56nvkndu52@ronaldradial.radialsg.local> <20141124093813.GL68776@ivaldir.etoilebsd.net>

next in thread | previous in thread | raw e-mail | index | archive | help
On Mon, 24 Nov 2014 10:38:14 +0100, Baptiste Daroussin <bapt@freebsd.org>  
wrote:

> On Mon, Nov 24, 2014 at 10:19:08AM +0100, Ronald Klop wrote:
>> On Mon, 24 Nov 2014 08:23:17 +0100, Joel Dahl <joel@vnode.se> wrote:
>>
>> > On Sun, Nov 23, 2014 at 10:04:12PM +0100, Baptiste Daroussin wrote:
>> >> On Sun, Nov 23, 2014 at 09:00:00PM +0000, Joel Dahl wrote:
>> >> > Author: joel (doc committer)
>> >> > Date: Sun Nov 23 21:00:00 2014
>> >> > New Revision: 274925
>> >> > URL: https://svnweb.freebsd.org/changeset/base/274925
>> >> >
>> >> > Log:
>> >> >   Misc mdoc fixes:
>> >> >
>> >> >   - Remove superfluous paragraph macros.
>> >> >   - Remove/fix empty or incorrect macros.
>> >> >   - Sort sections into conventional order.
>> >> >   - Terminate quoted strings properly.
>> >> >   - Remove EOL whitespace.
>> >> >
>> >> > Modified:
>> >> >   head/lib/libc/sys/poll.2
>> >> >   head/lib/libdpv/dpv.3
>> >> >   head/sbin/ipfw/ipfw.8
>> >> >   head/share/man/man4/gre.4
>> >> >   head/share/man/man4/man4.arm/cgem.4
>> >> >   head/share/man/man4/me.4
>> >> >   head/share/man/man4/netmap.4
>> >> >   head/share/man/man9/get_cyclecount.9
>> >> >   head/share/man/man9/malloc.9
>> >> >   head/share/man/man9/sleepqueue.9
>> >> >   head/sys/boot/common/zfsloader.8
>> >> >   head/sys/boot/i386/gptzfsboot/gptzfsboot.8
>> >> >   head/usr.bin/dpv/dpv.1
>> >> >
>> >>
>> >> [...]
>> >>
>> >> > +.Sh AUTHORS
>> >> > +This manual page was written by
>> >> > +.An Andriy Gapon Aq avg@FreeBSD.org .
>> >>                        ^ There should be a Mt here to properly render
>> >> in html
>> >>
>> >> I just picked one in the middle of this commit. In general every mail
>> >> on any
>> >> manpage Mt should be used.
>> >
>> > Sure. Feel free to go over our manpages and fix them. It's a minor  
>> issue.
>> >
>> > And while we're on the subject, there's a bit of background to this
>> > commit.
>> > Back in 2012 I started fixing mandoc lint errors/warnings in our  
>> manpage
>> > collection (excluding stuff from contrib/ and gnu/ etc.). I think I  
>> got
>> > them
>> > down from around ~4000 issues to almost zero. Quite a few manpages  
>> didn't
>> > even work with mandoc at the time, due to how many syntactical mdoc
>> > errors
>> > they had. The situation is still good, but I re-ran my scripts  
>> yesterday
>> > and
>> > found a slew of new warnings. I fixed a few obvious ones, but if  
>> someone
>> > with
>> > more time on his hands wants to help, please go ahead. A good starting
>> > point
>> > would probably the netmap.4 or ctl.conf.5 manpages, they seem to  
>> generate
>> > quite a few warnings.
>> >
>> > I'd also be grateful if everyone ran mandoc -Tlint on their manpages
>> > before
>> > committing. :-)
>> >
>>
>> A commit hook does magic for these kind of things. ;-)
>
> Except that such commit hook will prevent updating openssl and/or  
> kerberos :)
>
> Regards,
> Bapt

Yes, at work people can commit does things by adding a line in the commit  
message. Like 'Allowed by: vendor code commit'. Otherwise major style  
errors just prevent the commit. It helps raising the awareness of what  
they are doing.

Ronald.



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