Bug 35903
| Summary: | physio(9) does not have an AUTHOR section | ||
|---|---|---|---|
| Product: | Documentation | Reporter: | darklogik <darklogik> |
| Component: | Books & Articles | Assignee: | freebsd-doc (Nobody) <doc> |
| Status: | Closed FIXED | ||
| Severity: | Affects Only Me | ||
| Priority: | Normal | ||
| Version: | Latest | ||
| Hardware: | Any | ||
| OS: | Any | ||
|
Description
darklogik
2002-03-14 23:00:03 UTC
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 Tom Rhodes <darklogik@pittgoth.com> 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. 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 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. |
