Mentioning PR's in ChangeLogs

Mentioning PR's in ChangeLogs

[Andrew Cagney]

Hello,

So anyone know what correct protocol is?  A ChangeLog should definitly
standup on its own right vis:

	* foo.c: Fix pr/12

being definitly invalid.  Beyond that, I don't know.

	Andrew

Re: Mentioning PR's in ChangeLogs

[J.T. Conklin]

>>>>> "Andrew" == Andrew Cagney <ac131313@cygnus.com> writes:
Andrew> Hello,
Andrew> So anyone know what correct protocol is?  A ChangeLog should definitly
Andrew> standup on its own right vis:
Andrew>
Andrew> 	* foo.c: Fix pr/12
Andrew>
Andrew> being definitly invalid.  Beyond that, I don't know.

Agreed.  

IMO, the ChangeLog entry for a change that fixes a PR should be no
different than any other ChangeLog entry, except perhaps some tag 
that indicates the PR.  There are no conventions for this in
standards.texi, at least not the last time I looked.  It would be
good to be consistant.  

How about just appending "(pr/XX)" to the end of the description?  IMO
that works well for single line changes, less so for others.

        --jtc

-- 
J.T. Conklin
RedBack Networks

Re: Mentioning PR's in ChangeLogs

[Andrew Cagney]

To close this thread.  I'll add a recommendation to specify ``Fix
gdb/NNNN.'' in the CONTRIBUTE file.  I suspect (gdb/NNNN) will confuse
emacs's M-Q key.

Separatly, I (well someone) should merge CONTRIBUTE back into the coding
section of doc/*.texinfo directory.  CONTRIBUTE being auto-generated.

thanks for the comments,

	Andrew

Re: Mentioning PR's in ChangeLogs

[Tom Tromey]

>>>>> "Andrew" == Andrew Cagney <ac131313@cygnus.com> writes:

Andrew> So anyone know what correct protocol is?  A ChangeLog should
Andrew> definitly standup on its own right vis:
Andrew> 	* foo.c: Fix pr/12
Andrew> being definitly invalid.  Beyond that, I don't know.

FYI: on sources, if your CVSROOT/loginfo is set up properly, you can
have commits which mention a PR automatically be appended to the PR.

You have to mention the PR in the commit message with the correct
syntax, namely it must contain the text `PR category/NNN', where
`category' is the correct category name for the PR and `NNN' is the PR
number.

This puts the commit message into the PR.  If you've turned on cvsweb
URLs for the commit messages (again in loginfo) then this provides a
simple gnats/cvs integration: you can go directly from the PR to the
patches which supposedly fixed it.

In gcj-land we've adopted the policy of including text like `Fixed PR
gcj/2929' in the ChangeLog entry.  That's in addition to, not in place
of, whatever other ChangeLog description we write.

Tom

Re: Mentioning PR's in ChangeLogs

[Eli Zaretskii]

> Date: Fri, 23 Feb 2001 17:00:26 -0500
> From: Andrew Cagney <ac131313@cygnus.com>
> 
> Separatly, I (well someone) should merge CONTRIBUTE back into the coding
> section of doc/*.texinfo directory.  CONTRIBUTE being auto-generated.

You mean, to have e.g. doc/contribute.texi that is @include'd in
gdbint.texinfo, and from which CONTRIBUTE is generated at package tar
time?

Re: Mentioning PR's in ChangeLogs

[Andrew Cagney]

Eli Zaretskii wrote:
> 
> > Date: Fri, 23 Feb 2001 17:00:26 -0500
> > From: Andrew Cagney <ac131313@cygnus.com>
> >
> > Separatly, I (well someone) should merge CONTRIBUTE back into the coding
> > section of doc/*.texinfo directory.  CONTRIBUTE being auto-generated.
> 
> You mean, to have e.g. doc/contribute.texi that is @include'd in
> gdbint.texinfo, and from which CONTRIBUTE is generated at package tar
> time?

Yes, it could be something like that (but we'll skip any details :-)

	Andrew

Re: Mentioning PR's in ChangeLogs

[Andrew Cagney]

Tom Tromey wrote:

Hmm, this is the answer I was looking for!

> FYI: on sources, if your CVSROOT/loginfo is set up properly, you can
> have commits which mention a PR automatically be appended to the PR.
> 
> You have to mention the PR in the commit message with the correct
> syntax, namely it must contain the text `PR category/NNN', where
> `category' is the correct category name for the PR and `NNN' is the PR
> number.
> 
> This puts the commit message into the PR.  If you've turned on cvsweb
> URLs for the commit messages (again in loginfo) then this provides a
> simple gnats/cvs integration: you can go directly from the PR to the
> patches which supposedly fixed it.
> 
> In gcj-land we've adopted the policy of including text like `Fixed PR
> gcj/2929' in the ChangeLog entry.  That's in addition to, not in place
> of, whatever other ChangeLog description we write.

Making it:

	.....  Fixed PR gdb/4705.

will tweek.

Andrew