Re: [PATCH 2/2] GDB: S12Z: new function s12z_extract_return_value

Kevin Buettner
2018-11-18T18:28:50Z

On Sun, 18 Nov 2018 10:13:37 +0100
John Darrington <john@darrington.wattle.id.au> wrote:

> Hi Kevin,
>
> Thanks for the review.
>
> On Sat, Nov 17, 2018 at 11:35:50PM -0700, Kevin Buettner wrote:
> >
> > gdb/ChangeLog:
> > * s12z-tdep.c (s12z_extract_return_value): New function.
> > (inv_reg_perm) New array.
> > (s12z_return_value): Populate readbuf if non-null.
>
> Make sure that this is indented correctly when it eventually goes
> in the ChangeLog file.
>
> Is it documented anywhere what "correctly" means?

https://www.gnu.org/prep/standards/standards.html#Change-Logs
https://www.gnu.org/software/emacs/manual/html_node/emacs/Format-of-ChangeLog.html

Though with regards to indentation, neither of those links adequately
describe the ChangeLog entries that we've been using for many years
now.

When you do the commit / push, your ChangeLog entry should look something
like this:

YYYY-MM-DD John Darrington <john@darrington.wattle.id.au>

* s12z-tdep.c (s12z_extract_return_value): New function.
(inv_reg_perm) New array.
(s12z_return_value): Populate readbuf if non-null.

In particular, a single tab precedes the non-header (and non-empty)
portions of the ChangeLog entry.

Kevin