git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Anomalous AUTHOR and DOCUMENTATION sections in manpages

From
Michael Haggerty <mhagger@alum.mit.edu>
Date
Jan 22, 2014, 11:22 UTC
Message-ID
<52DFA9EF.4080309@alum.mit.edu>

I just noticed that there are exactly four Git manpages with an "AUTHOR" section and five with a "DOCUMENTATION" section:

    $ make doc
    $ grep -nIE -e '^\.SH "DOCUMENTATION|AUTHOR"' Documentation/*.[0-9]
    Documentation/git-column.1:80:.SH "AUTHOR"
    Documentation/git-for-each-ref.1:272:.SH "AUTHOR"
    Documentation/git-for-each-ref.1:275:.SH "DOCUMENTATION"
    Documentation/git-http-backend.1:404:.SH "AUTHOR"
    Documentation/git-http-backend.1:407:.SH "DOCUMENTATION"
    Documentation/git-notes.1:395:.SH "AUTHOR"
    Documentation/git-notes.1:398:.SH "DOCUMENTATION"
    Documentation/git-remote-ext.1:133:.SH "DOCUMENTATION"
    Documentation/git-remote-fd.1:71:.SH "DOCUMENTATION"

These sections are inconsistent with the other manpages and seem superfluous in a project that has, on the one hand, a public history and, on the other hand, hundreds of contributors. Would the mentioned authors (CCed) consent to the removal of these sections?

I don't want to step on any feet here. If you want to keep these sections, I have no objection. But my guess is that people added them in these few instances without realizing that these sections are not commonly used in Git documentation.

Michael
-- 
Michael Haggerty
mhagger@alum.mit.edu
http://softwareswirl.blogspot.com/
Next: Duy Nguyen
Message 1 of 8 in “Anomalous AUTHOR and DOCUMENTATION sections in manpages”
  1. Michael HaggertyJan 22, 2014
  2. Duy NguyenJan 22, 2014
  3. Johan HerlandJan 22, 2014
  4. Johannes SchindelinJan 22, 2014
  5. Junio C HamanoJan 22, 2014
  6. Shawn PearceJan 22, 2014
  7. Ilari LiusvaaraJan 22, 2014
  8. Michael HaggertyJan 22, 2014

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.