bug#20400: wrong author line in generated ChangeLog

bug#20400: wrong author line in generated ChangeLog

[Glenn Morris]

Package: emacs
Version: 25.0.50

`make ChangeLog' gives me a file containing this:

2015-04-19  Steve Purcell  <steve@sanityinc.com>
            Steve Purcell  <steve@sanityinc.com>

Presumably this is due to a mistake in
http://lists.gnu.org/archive/html/emacs-diffs/2015-04/msg00308.html

Three things to fix IMO:

1) That specific ChangeLog entry

2) The description of Co-authored-by in CONTRIBUTE seems misleading. I
guess it should say something along the lines of "If the commit has
authors other than the one listed in the Author: header (ie, the one
passed to git commit --author")..." rather than "other than yourself".

3) The ChangeLog generation script should avoid listing literally
identical authors twice.

bug#20400: wrong author line in generated ChangeLog

[Artur Malabarba]

[-- Attachment #1: Type: text/plain, Size: 588 bytes --]

Sorry about this.

> 2) The description of Co-authored-by in CONTRIBUTE seems misleading. I
> guess it should say something along the lines of "If the commit has
> authors other than the one listed in the Author: header (ie, the one
> passed to git commit --author")..." rather than "other than yourself".

Yes, please. That's exactly what caused my confusion.
CONTRIBUTE should tell us to use the regular git author, and then mention
that the header is available for when additional authors are needed. The
way it is written sounds like you must use the header if the author is not
you.

[-- Attachment #2: Type: text/html, Size: 697 bytes --]

bug#20400: wrong author line in generated ChangeLog

[Eli Zaretskii]

> Date: Fri, 24 Apr 2015 15:40:45 +0100
> From: Artur Malabarba <bruce.connor.am@gmail.com>
> Cc: 20400@debbugs.gnu.org
> 
> > 2) The description of Co-authored-by in CONTRIBUTE seems misleading. I
> > guess it should say something along the lines of "If the commit has
> > authors other than the one listed in the Author: header (ie, the one
> > passed to git commit --author")..." rather than "other than yourself".
> 
> Yes, please. That's exactly what caused my confusion. 
> CONTRIBUTE should tell us to use the regular git author, and then mention that
> the header is available for when additional authors are needed. The way it is
> written sounds like you must use the header if the author is not you. 

I fixed this, although with a different text than suggested above
(which I find too long and confusing).  Let me know if the new text
needs more work.

bug#20400: wrong author line in generated ChangeLog

[Artur Malabarba]

Looks fine to me. Thanks Eli.

2015-04-24 15:49 GMT+01:00 Eli Zaretskii <eliz@gnu.org>:
>> Date: Fri, 24 Apr 2015 15:40:45 +0100
>> From: Artur Malabarba <bruce.connor.am@gmail.com>
>> Cc: 20400@debbugs.gnu.org
>>
>> > 2) The description of Co-authored-by in CONTRIBUTE seems misleading. I
>> > guess it should say something along the lines of "If the commit has
>> > authors other than the one listed in the Author: header (ie, the one
>> > passed to git commit --author")..." rather than "other than yourself".
>>
>> Yes, please. That's exactly what caused my confusion.
>> CONTRIBUTE should tell us to use the regular git author, and then mention that
>> the header is available for when additional authors are needed. The way it is
>> written sounds like you must use the header if the author is not you.
>
> I fixed this, although with a different text than suggested above
> (which I find too long and confusing).  Let me know if the new text
> needs more work.

bug#20400: wrong author line in generated ChangeLog

[Paul Eggert]

I ran 'make change-history', committed the typo fix to ChangeLog.2, and am 
marking this as done.