From darklogik@pittgoth.com Thu Mar 14 14:58:48 2002 Return-Path: Received: from pittgoth.com (14.zlnp1.xdsl.nauticom.net [209.195.149.111]) by hub.freebsd.org (Postfix) with ESMTP id C1BD437B416 for ; Thu, 14 Mar 2002 14:58:47 -0800 (PST) Received: (from darklogik@localhost) by pittgoth.com (8.11.6/8.11.6) id g2EN10x17620; Thu, 14 Mar 2002 18:01:00 -0500 (EST) (envelope-from darklogik) Message-Id: <200203142301.g2EN10x17620@pittgoth.com> Date: Thu, 14 Mar 2002 18:01:00 -0500 (EST) From: Tom Rhodes Reply-To: Tom Rhodes To: FreeBSD-gnats-submit@freebsd.org Cc: Subject: physio(9) does not have an AUTHOR section X-Send-Pr-Version: 3.113 X-GNATS-Notify: >Number: 35903 >Category: docs >Synopsis: physio(9) does not have an AUTHOR section >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: closed >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Thu Mar 14 15:00:03 PST 2002 >Closed-Date: Sun Mar 17 20:41:06 PST 2002 >Last-Modified: Sun Mar 17 20:41:06 PST 2002 >Originator: Tom Rhodes >Release: FreeBSD 4.5-RELEASE i386 >Organization: >Environment: System: FreeBSD pittgoth.com 4.5-RELEASE FreeBSD 4.5-RELEASE #2: Thu Feb 21 23:00:49 EST 2002 root@pittgoth.com:/usr/src/sys/compile/PITTGOTH i386 >Description: physio(9) lacks an authors section, I think that about 90% of the man pages have this section regardless... Awhile ago Hiten wrote/rewrote/fixed this man page, I think he should at least be listed as an author or an authors section added with a (revised by) comment. >How-To-Repeat: man 9 physio and notice the lacking authors section >Fix: Add an authors section, or a note to give credit where credit is due... Sorry, i'm a strong one on credit, and I was cleaning out my mailbox and noticed this hehe... >Release-Note: >Audit-Trail: From: Dima Dorfman To: Tom Rhodes Cc: FreeBSD-gnats-submit@freebsd.org Subject: Re: docs/35903: physio(9) does not have an AUTHOR section Date: Fri, 15 Mar 2002 01:33:09 +0000 Tom Rhodes wrote: > >Description: > physio(9) lacks an authors section, I think that about > 90% of the man pages have this section regardless... Awhile ago Hiten > wrote/rewrote/fixed this man page, I think he should at least be listed > as an author or an authors section added with a (revised by) comment. The normal way to credit this kind of submission is to list the submitter as such in the commit log. For some reason (probably forgetfulness), joe didn't do this. This can be rectified by a forced commit log if people think it's a big deal, but I think it's somewhat too late for that. I also don't think it's appropriate to add every submitter to the AUTHORS section (please don't take this to mean that I don't appreciate the contributions), esp. when the original author didn't add himself, but I won't fight over this issue. From: darklogik To: dima@trit.org Cc: freebsd-doc@FreeBSD.ORG, FreeBSD-gnats-submit@FreeBSD.ORG Subject: Re: docs/35903: physio(9) does not have an AUTHOR section Date: Fri, 15 Mar 2002 00:30:06 +0008 (EST) Not that an arguement needs started, or a dispute needs to arise, but may I throw the following idea on the table for everyones evauluation: No author listed, who would be contacted if this manual document became out of date, who would fix it? Who already knows about it? Could we just dub Hiten, as the last person who worked with it, the current author and maintainer of this document? It would be good, in my opinion of course, for users to have an idea of who to contact if in fact this document needs changing. Many times we get prs saying ``this needs changed'' and yet it either sits for many days/weeks until someone has the time to investigate the problem, or knowledge to apply a quick fix? In closing, I guess that this is just a request to assign Hiten as the author of this document, and maybe even list an (unknown origin) under the authors section. Is this idea feasable? -- Tom (Darklogik) Rhodes From: Murray Stokely To: Tom Rhodes Cc: FreeBSD-gnats-submit@freebsd.org Subject: Re: docs/35903: physio(9) does not have an AUTHOR section Date: Fri, 15 Mar 2002 23:49:08 -0800 On Thu, Mar 14, 2002 at 06:01:00PM -0500, Tom Rhodes wrote: > physio(9) lacks an authors section, I think that about > 90% of the man pages have this section regardless... Awhile ago Hiten > wrote/rewrote/fixed this man page, I think he should at least be listed > as an author or an authors section added with a (revised by) comment. The author section lists people who wrote the software, or wrote the man page. Adding a sentence or two (or even a paragraph or two) is not the same as writing the document. Individual contributors are credited in commit messages. Hiten has be credited many times lately for his numerous contributions. - Murray State-Changed-From-To: open->closed State-Changed-By: murray State-Changed-When: Sun Mar 17 20:40:47 PST 2002 State-Changed-Why: Big thanks to Hiten and everyone else who is contributing lately, but his name doesn't belong in the AUTHORS section. In general, the AUTHORS section should list the people who wrote the software being described, or who wrote the majority (>50%) of the text of the man page. http://www.freebsd.org/cgi/query-pr.cgi?pr=35903 >Unformatted: