Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Joel Brobecker <brobecker@adacore.com>
Cc: gdb-patches@sources.redhat.com
Subject: Re: [RFA/doc] New Year Procedure
Date: Wed, 23 Nov 2005 08:46:00 -0000	[thread overview]
Message-ID: <uy83gwhko.fsf@gnu.org> (raw)
In-Reply-To: <20051122195636.GR1635@adacore.com> (message from Joel Brobecker 	on Tue, 22 Nov 2005 11:56:36 -0800)

> 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.


  reply	other threads:[~2005-11-22 20:31 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-11-22 20:31 Joel Brobecker
2005-11-23  8:46 ` Eli Zaretskii [this message]
2005-11-25 14:15   ` Joel Brobecker
2005-11-25 14:30     ` Eli Zaretskii
2005-11-28  1:17       ` Joel Brobecker

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=uy83gwhko.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=brobecker@adacore.com \
    --cc=gdb-patches@sources.redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox