[RFA/doc] New Year Procedure

Eli Zaretskii eliz@gnu.org
Wed Nov 23 08:46:00 GMT 2005


> Date: Tue, 22 Nov 2005 11:56:36 -0800
> From: Joel Brobecker <brobecker@adacore.com>
> 
> A new chapter to document the list of actions that need to be performed
> at the start of each new year.

Thanks.

> 2005-11-22  Joel Brobecker  <brobecker@adacore.com>
> 
>         * gdbint.texinfo (Start of New Year Procedure): New chapter

Please add a period at the end of this line.

> +@node Start of New Year Procedure
> +@chapter Start of New Year Procedure

A @cindex entry would be good here.  Think about yourself a year from
now looking for this chapter: typing "i new year RET" inside an Info
reader will land you here with minimum fuss.

> +@itemize @bullet
> +@item Rotate the ChangeLog file

In an @itemize list, @item should be alone on its line, like this:

  @itemize @bullet
  @item
  Rotate the ChangeLog file

> +@smallexample
> +Local Variables:
> +mode: change-log
> +left-margin: 8
> +fill-column: 74
> +version-control: never
> +End:

Perhaps we should say a few words (e.g., in a @footnote) why this
gobbledygook should be in ChangeLog.  Not everyone is an Emacs
junkie ;-)

> +@end smallexample
> +@item Update the copyright year in the startup message

Same here.  Also, please leave one empty line before @item.

> +Update the copyright year in @file{top.c}:@code{print_gdb_version}.

Doesn't this look ugly?  Because @file produces single quotes, so you
get `top.c':`print_gdb_version' in Info and `top.c':print_gdb_version
in print; both aren't pretty, IMHO.

How about simply spelling it out:

  Update the copyright year in @file{top.c}, function
  @code{print_gdb_version}.

Other than that, this can go in.



More information about the Gdb-patches mailing list