Re: [RFA/doco] Update the "Start of New Year Procedure"

[Joel Brobecker <brobecker@adacore.com>]

[-- Attachment #1: Type: text/plain, Size: 1263 bytes --]

> > +Run the @code{copyright.sh} script to add the new year in the copyright
> > +notices of most source files.  This script requires Emacs 22 or later to
> > +be installed.
> 
> It's better to put copyright.sh in @file, not in @code.

Fixed.

>   @item
>   @file {*.f}
>   ...
> 
> Did you have a good reason for not using the canonical form?  If not,
> I'd prefer to use it, although I won't object to what you did as well.

No problem, I did not have a specific reason for writing it this way,
other than it seems easier to read it.  I also fixed another list
just a few lines above.

> Also, perhaps it is worthwhile to spell out the language for each file
> type.  Again, that's not a blocking comment.

I don't think this is worth the effort, here. This is just a checklist
for someone like me who needs an easy reminder of which files will need
to be updated by hand. I don't need to know in which language each file
is written to know how to update it. It's usually obvious once opened.

Here is the patch I ended up checking in.

2010-01-01  Joel Brobecker  <brobecker@adacore.com>

        Update the "Start of New Year Procedure".
        * gdbint.texinfo: Add the list of files that need to be updated
        manually.  Minor reformatting.

-- 
Joel

[-- Attachment #2: start-of-new-year.diff --]
[-- Type: text/x-diff, Size: 1694 bytes --]

Index: gdbint.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdbint.texinfo,v
retrieving revision 1.315
diff -u -p -r1.315 gdbint.texinfo
--- gdbint.texinfo	1 Jan 2010 07:54:37 -0000	1.315
+++ gdbint.texinfo	1 Jan 2010 11:37:17 -0000
@@ -6752,15 +6752,44 @@ Update the copyright year in the startup
 
 Update the copyright year in:
 @itemize @bullet
-@item file @file{top.c}, function @code{print_gdb_version}
-@item file @file{gdbserver/server.c}, function @code{gdbserver_version}
-@item file @file{gdbserver/gdbreplay.c}, function @code{gdbreplay_version}
+  @item
+  file @file{top.c}, function @code{print_gdb_version}
+  @item
+  file @file{gdbserver/server.c}, function @code{gdbserver_version}
+  @item
+  file @file{gdbserver/gdbreplay.c}, function @code{gdbreplay_version}
 @end itemize
 
 @item
-Add the new year in the copyright notices of all source and documentation
-files.  This can be done semi-automatically by running the @code{copyright.sh}
-script.  This script requires Emacs 22 or later to be installed.
+Run the @file{copyright.sh} script to add the new year in the copyright
+notices of most source files.  This script requires Emacs 22 or later to
+be installed.
+
+@item
+The new year also needs to be added manually in all other files that
+are not already taken care of by the @file{copyright.sh} script:
+@itemize @bullet
+  @item
+  @file{*.s}
+  @item
+  @file{*.f}
+  @item
+  @file{*.f90}
+  @item
+  @file{*.igen}
+  @item
+  @file{*.ac}
+  @item
+  @file{*.texi}
+  @item
+  @file{*.texinfo}
+  @item
+  @file{*.tex}
+  @item
+  @file{*.defs}
+  @item
+  @file{*.1}
+@end itemize
 
 @end itemize