# Anomalous AUTHOR and DOCUMENTATION sections in manpages 8 messages from 2014-01-22 to 2014-01-22. Participants: Michael Haggerty, Duy Nguyen, Johan Herland, Johannes Schindelin, Junio C Hamano, Shawn Pearce, Ilari Liusvaara. Thread: https://gitlist.dev/t/35707 ## Michael Haggerty, 2014-01-22 11:22 Subject: Anomalous AUTHOR and DOCUMENTATION sections in manpages Message-ID: <52DFA9EF.4080309@alum.mit.edu> URL: https://gitlist.dev/e/52DFA9EF.4080309%40alum.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/ ``` ## Duy Nguyen, 2014-01-22 11:39 Subject: Re: Anomalous AUTHOR and DOCUMENTATION sections in manpages Message-ID: URL: https://gitlist.dev/e/CACsJy8AEU2dQPNknazRxEh12MNd%3D3Kw3%2B_tc3meS_Bs961ERkA%40mail.gmail.com In-Reply-To: <52DFA9EF.4080309@alum.mit.edu> ``` On Wed, Jan 22, 2014 at 6:22 PM, Michael Haggerty wrote: > 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? No problem from me. -- Duy ``` ## Johan Herland, 2014-01-22 12:06 Subject: Re: Anomalous AUTHOR and DOCUMENTATION sections in manpages Message-ID: URL: https://gitlist.dev/e/CALKQrgdvgxAW50-YdKTd-fo7r6S5Hf8jA4Eh1VtzFhvytOzqYg%40mail.gmail.com In-Reply-To: ``` On Wed, Jan 22, 2014 at 12:39 PM, Duy Nguyen wrote: > On Wed, Jan 22, 2014 at 6:22 PM, Michael Haggerty wrote: >> 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? > > No problem from me. No problems here. -- Johan Herland, www.herland.net ``` ## Johannes Schindelin, 2014-01-22 14:43 Subject: Re: Anomalous AUTHOR and DOCUMENTATION sections in manpages Message-ID: URL: https://gitlist.dev/e/alpine.DEB.1.00.1401221542190.14982%40s15462909.onlinehome-server.info In-Reply-To: <52DFA9EF.4080309@alum.mit.edu> ``` Hi Michael, On Wed, 22 Jan 2014, Michael Haggerty wrote: > Would the mentioned authors (CCed) consent to the removal of these > sections? Fine by me! Dscho P.S.: Congrats on your new job! ``` ## Junio C Hamano, 2014-01-22 15:51 Subject: Re: Anomalous AUTHOR and DOCUMENTATION sections in manpages Message-ID: URL: https://gitlist.dev/e/xmqqfvogypyu.fsf%40gitster.dls.corp.google.com In-Reply-To: <52DFA9EF.4080309@alum.mit.edu> ``` Michael Haggerty writes: > 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. We decided at 48bb914e (doc: drop author/documentation sections from most pages, 2011-03-11) to remove them for that exact reason. I'd be happy to see the one in for-each-ref under my name go. Thanks. ``` ## Shawn Pearce, 2014-01-22 19:49 Subject: Re: Anomalous AUTHOR and DOCUMENTATION sections in manpages Message-ID: URL: https://gitlist.dev/e/CAJo%3DhJuW3BdZUpvGL3fgry%3Dw04YpwZTUZkMW6BeeTXfMbyKK6A%40mail.gmail.com In-Reply-To: <52DFA9EF.4080309@alum.mit.edu> ``` On Wed, Jan 22, 2014 at 3:22 AM, Michael Haggerty wrote: > 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? Fine by me, authorship is documented by history and blame anyway. :-) ``` ## Ilari Liusvaara, 2014-01-22 20:15 Subject: Re: Anomalous AUTHOR and DOCUMENTATION sections in manpages Message-ID: <20140122201507.GA15111@LK-Perkele-VII> URL: https://gitlist.dev/e/20140122201507.GA15111%40LK-Perkele-VII In-Reply-To: <52DFA9EF.4080309@alum.mit.edu> ``` On Wed, Jan 22, 2014 at 12:22:23PM +0100, Michael Haggerty wrote: > I just noticed that there are exactly four Git manpages with an "AUTHOR" > section and five with a "DOCUMENTATION" section: > > 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? Sure (it has been copyedited a lot anyway). -Ilari ``` ## Michael Haggerty, 2014-01-22 21:41 Subject: Re: Anomalous AUTHOR and DOCUMENTATION sections in manpages Message-ID: <52E03B1D.4060207@alum.mit.edu> URL: https://gitlist.dev/e/52E03B1D.4060207%40alum.mit.edu In-Reply-To: <52DFA9EF.4080309@alum.mit.edu> ``` On 01/22/2014 12:22 PM, Michael Haggerty wrote: > 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. Thanks for the quick responses, everybody. I'll prepare a patch. Michael -- Michael Haggerty mhagger@alum.mit.edu http://softwareswirl.blogspot.com/ ```