From: Michael Haggerty <mhagger@alum.mit.edu>
To: git discussion list <git@vger.kernel.org>
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Shawn O. Pearce" <spearce@spearce.org>,
"Jonathan Nieder" <jrnieder@gmail.com>,
"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>,
"Johan Herland" <johan@herland.net>,
"Johannes Schindelin" <johannes.schindelin@gmx.de>,
"Ilari Liusvaara" <ilari.liusvaara@elisanet.fi>
Subject: Anomalous AUTHOR and DOCUMENTATION sections in manpages
Date: Wed, 22 Jan 2014 12:22:23 +0100 [thread overview]
Message-ID: <52DFA9EF.4080309@alum.mit.edu> (raw)
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 reply other threads:[~2014-01-22 11:22 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-01-22 11:22 Michael Haggerty [this message]
2014-01-22 11:39 ` Anomalous AUTHOR and DOCUMENTATION sections in manpages Duy Nguyen
2014-01-22 12:06 ` Johan Herland
2014-01-22 14:43 ` Johannes Schindelin
2014-01-22 15:51 ` Junio C Hamano
2014-01-22 19:49 ` Shawn Pearce
2014-01-22 20:15 ` Ilari Liusvaara
2014-01-22 21:41 ` Michael Haggerty
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=52DFA9EF.4080309@alum.mit.edu \
--to=mhagger@alum.mit.edu \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=ilari.liusvaara@elisanet.fi \
--cc=johan@herland.net \
--cc=johannes.schindelin@gmx.de \
--cc=jrnieder@gmail.com \
--cc=pclouds@gmail.com \
--cc=spearce@spearce.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.