From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-41642-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 25742 invoked by alias); 22 Nov 2005 20:31:58 -0000
Received: (qmail 25725 invoked by uid 22791); 22 Nov 2005 20:31:57 -0000
X-Spam-Check-By: sourceware.org
Received: from romy.inter.net.il (HELO romy.inter.net.il) (192.114.186.66)     by sourceware.org (qpsmtpd/0.31) with ESMTP; Tue, 22 Nov 2005 20:31:55 +0000
Received: from HOME-C4E4A596F7 (IGLD-80-230-144-137.inter.net.il [80.230.144.137]) 	by romy.inter.net.il (MOS 3.5.8-GR) 	with ESMTP id DAK79032 (AUTH halo1); 	Tue, 22 Nov 2005 22:31:04 +0200 (IST)
Date: Wed, 23 Nov 2005 08:46:00 -0000
Message-Id: <uy83gwhko.fsf@gnu.org>
From: Eli Zaretskii <eliz@gnu.org>
To: Joel Brobecker <brobecker@adacore.com>
CC: gdb-patches@sources.redhat.com
In-reply-to: <20051122195636.GR1635@adacore.com> (message from Joel Brobecker 	on Tue, 22 Nov 2005 11:56:36 -0800)
Subject: Re: [RFA/doc] New Year Procedure
Reply-to: Eli Zaretskii <eliz@gnu.org>
References:  <20051122195636.GR1635@adacore.com>
X-IsSubscribed: yes
Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm
Precedence: bulk
List-Subscribe: <mailto:gdb-patches-subscribe@sourceware.org>
List-Archive: <http://sourceware.org/ml/gdb-patches/>
List-Post: <mailto:gdb-patches@sourceware.org>
List-Help: <mailto:gdb-patches-help@sourceware.org>, <http://sourceware.org/ml/#faqs>
Sender: gdb-patches-owner@sourceware.org
X-SW-Source: 2005-11/txt/msg00425.txt.bz2

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