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

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

[Joel Brobecker]

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

Hello,

I would like to clarify a little bit the process needed to update
the copyright headers. Patch attached.

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.

Tested by rebuilding gdbint in html and PDF formats. I checked
the result on both outputs.

Thanks,
-- 
Joel

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

commit 90c110a4557433b771a46b7df285e6f8ad64da91
Author: Joel Brobecker <brobecker@adacore.com>
Date:   Fri Jan 1 13:07:04 2010 +0400

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

diff --git a/gdb/doc/gdbint.texinfo b/gdb/doc/gdbint.texinfo
index dbe1197..3af8622 100644
--- a/gdb/doc/gdbint.texinfo
+++ b/gdb/doc/gdbint.texinfo
@@ -6758,9 +6758,25 @@ Update the copyright year in:
 @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 @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.
+
+@item
+The new year also needs to be added manually in all other files that
+are not already taken care of by the @code{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
 

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

[Eli Zaretskii]

> Date: Fri, 1 Jan 2010 13:10:09 +0400
> From: Joel Brobecker <brobecker@adacore.com>
> 
> I would like to clarify a little bit the process needed to update
> the copyright headers. Patch attached.

Thanks.

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

> +@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

Although this format is permitted, the canonical way of writing an
itemized list is to have @item on its own line:

  @item
  @file{*.s}
  @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.

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

Otherwise, okay with me.

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

[Joel Brobecker]

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

[RFA/doco] Update the ``Start of New Year Procedure''

[Joel Brobecker]

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

Hello,

Following the omissions discovered this year, this is an update
to the documentation, for next year

2009-01-06  Joel Brobecker  <brobecker@adacore.com>

        * gdbint.texinfo (Start of New Year Procedure): Add the "coding"
        emacs local variable to be placed at the end of the ChangeLog.
        Add server.c and gdbreplay.c to the list of files were the
        copyright year needs to be updated.

OK to commit?

Thanks,
-- 
Joel

[-- Attachment #2: new-year.diff --]
[-- Type: text/plain, Size: 997 bytes --]

Index: gdbint.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdbint.texinfo,v
retrieving revision 1.294
diff -u -p -r1.294 gdbint.texinfo
--- gdbint.texinfo	28 Dec 2008 23:35:52 -0000	1.294
+++ gdbint.texinfo	6 Jan 2009 04:56:51 -0000
@@ -5842,6 +5842,7 @@ mode: change-log
 left-margin: 8
 fill-column: 74
 version-control: never
+coding: utf-8
 End:
 @end smallexample
 
@@ -5852,8 +5853,12 @@ in @file{gdb/config/djgpp/fnchange.lst}.
 @item
 Update the copyright year in the startup message
 
-Update the copyright year in file @file{top.c}, function
-@code{print_gdb_version}.
+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}
+@end itemize
 
 @item
 Add the new year in the copyright notices of all source and documentation

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

[Daniel Jacobowitz]

On Tue, Jan 06, 2009 at 09:03:13AM +0400, Joel Brobecker wrote:
> Hello,
> 
> Following the omissions discovered this year, this is an update
> to the documentation, for next year
> 
> 2009-01-06  Joel Brobecker  <brobecker@adacore.com>
> 
>         * gdbint.texinfo (Start of New Year Procedure): Add the "coding"
>         emacs local variable to be placed at the end of the ChangeLog.
>         Add server.c and gdbreplay.c to the list of files were the
>         copyright year needs to be updated.
> 
> OK to commit?

OK.

-- 
Daniel Jacobowitz
CodeSourcery

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

[Joel Brobecker]

> > 2009-01-06  Joel Brobecker  <brobecker@adacore.com>
> > 
> >         * gdbint.texinfo (Start of New Year Procedure): Add the "coding"
> >         emacs local variable to be placed at the end of the ChangeLog.
> >         Add server.c and gdbreplay.c to the list of files were the
> >         copyright year needs to be updated.
> 
> OK.

Thanks, Daniel. Checked in.

-- 
Joel