svn commit: r211501 - in head/sys: modules modules/send netinet netinet6 sys

Rui Paulo rpaulo at FreeBSD.org
Sat Aug 21 12:07:44 UTC 2010


On 20 Aug 2010, at 02:33, Doug Barton wrote:

> On 08/19/2010 14:50, Bjoern A. Zeeb wrote:
>> On Thu, 19 Aug 2010, Doug Barton wrote:
>> 
>>> On 08/19/2010 04:42, Ana Kukec wrote:
>>>> Hi all,
>>>> 
>>>> A man page for the kernel side SeND, and an updated port with
>>>> Secure Neighbor Discovery application will follow soon.
>>> 
>>> At minimum committing the man page along with new code is how such
>>> things should be done. Can you define "soon?"
>> 
>> Yes I can: soon will be when it'll be comitted.
> 
> I'm guessing that's an attempt at humor, but what I'm looking for is an actual timeline. If the answer is "in the next day or two" then that's fine, we'll let this one go with a warning. If the answer is "someday" then I'm going to request that the code be backed out until the man page(s) are done. I'm actually trying to be reasonable and work with a new developer so that they can learn how we like to have things done around here. What are you trying to do?

What? Are you serious? Do you really want some code to be backed out because it doesn't have a man page yet? Talking about overkill..
You don't seem to have an idea how many times code was committed without a man page.
I didn't see you complain back then.. It's very likely you wouldn't be complaining if the developer in question hadn't posted a message to the mailing list saying she intends to commit a man page soon.

> 
>> Meanwhile if you have time I'd know several dozen other things we
>> don't have a man page for ...
> 
> I would definitely recommend that you make a list of them, preferably someplace visible like the wiki. If you don't already have access to the wiki (or some other suitable forum) then send the list to -doc@ and we'll make sure that it gets posted. Given the recent resurgence of interest in updating our documentation it certainly wouldn't hurt to have some examples of low-hanging fruit that we can turn budding mdoc gurus loose on.
> 
> Meanwhile, the fact that in the past code has been committed without man pages is the exact cause of the problem you're describing. It is certainly not a justification for continuing to do it wrong.

Reverting code just because it doesn't have a man page is pointless. Everyone can write the damn man page, but not everyone can write code. You should really take this into consideration when proposing a commit to be reverted.

Regards,
--
Rui Paulo




More information about the svn-src-head mailing list