[rfa] gdb.texinfo: new release tarball commands

[rfa] gdb.texinfo: new release tarball commands

[Michael Elizabeth Chastain]

This patch updates gdbint.texinfo with the new instructions for making
a release tarball.  This is version #2 of this patch.

This time, I removed the whole section "Configuring @value{GDBN} for
Release".  Also, I added instructions for older versions of gdb which
do not have @file{src-release} (gdb 5.3.1 and older).

Note that more people than the release manager need this information.
I wrote this patch because I needed to know how snapshot tarballs were
made in order to debug a problem with testsuite/gdb.c++ files inside
the current snapshots.

Testing: I followed the instructions on gdb HEAD, gdb gdb_5_3-branch,
insight HEAD, insight gdb_5_3-banch, and dejagnu HEAD.  They worked.

OK to apply?

Michael C

2003-01-09  Michael Chastain  <mec@shout.net>

	* gdbint.texinfo (Configuring @value{GDBN} for Release): Delete.
	(Create a Release): Add new instructions for new @file{src-release}.
	Document existing instructions for @file{Makefile.in} as
	being for @value{GDBN} 5.3.1 or earlier.

Index: gdbint.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdbint.texinfo,v
retrieving revision 1.115
diff -u -r1.115 gdbint.texinfo
--- gdbint.texinfo	9 Jan 2003 18:46:02 -0000	1.115
+++ gdbint.texinfo	10 Jan 2003 20:03:37 -0000
@@ -5396,62 +5396,6 @@
 configuration.
 @end itemize
 
-@section Configuring @value{GDBN} for Release
-
-@cindex preparing a release
-@cindex making a distribution tarball
-From the top level directory (containing @file{gdb}, @file{bfd},
-@file{libiberty}, and so on):
-
-@smallexample
-make -f Makefile.in gdb.tar.gz
-@end smallexample
-
-@noindent
-This will properly configure, clean, rebuild any files that are
-distributed pre-built (e.g. @file{c-exp.tab.c} or @file{refcard.ps}),
-and will then make a tarfile.  (If the top level directory has already
-been configured, you can just do @code{make gdb.tar.gz} instead.)
-
-This procedure requires:
-
-@itemize @bullet
-
-@item 
-symbolic links;
-
-@item
-@code{makeinfo} (texinfo2 level);
-
-@item
-@TeX{};
-
-@item
-@code{dvips};
-
-@item
-@code{yacc} or @code{bison}.
-@end itemize
-
-@noindent
-@dots{} and the usual slew of utilities (@code{sed}, @code{tar}, etc.).
-
-@subheading TEMPORARY RELEASE PROCEDURE FOR DOCUMENTATION
-
-@file{gdb.texinfo} is currently marked up using the texinfo-2 macros,
-which are not yet a default for anything (but we have to start using
-them sometime).
-
-For making paper, the only thing this implies is the right generation of
-@file{texinfo.tex} needs to be included in the distribution.
-
-For making info files, however, rather than duplicating the texinfo2
-distribution, generate @file{gdb-all.texinfo} locally, and include the
-files @file{gdb.info*} in the distribution.  Note the plural;
-@code{makeinfo} will split the document into one overall file and five
-or so included files.
-
-
 @node Releasing GDB
 
 @chapter Releasing @value{GDBN}
@@ -5983,6 +5927,17 @@
 @subsubheading Do the dirty work
 
 This is identical to the process used to create the daily snapshot.
+
+@smallexample
+$  for m in gdb insight
+do
+( cd $m/src && gmake -f src-release $m.tar )
+done
+$  ( m=dejagnu; cd $m/src && gmake -f src-release $m.tar.bz2 )
+@end smallexample
+
+If the top level source directory does not have @file{src-release}
+(@value{GDBN} version 5.3.1 or earlier), try these commands instead.
 
 @smallexample
 $  for m in gdb insight

Re: [rfa] gdb.texinfo: new release tarball commands

[Andrew Cagney]

I like it :-)


> @@ -5983,6 +5927,17 @@
>  @subsubheading Do the dirty work
>  
>  This is identical to the process used to create the daily snapshot.
> +
> +@smallexample
> +$  for m in gdb insight
> +do
> +( cd $m/src && gmake -f src-release $m.tar )
> +done
> +$  ( m=dejagnu; cd $m/src && gmake -f src-release $m.tar.bz2 )
> +@end smallexample
> +
> +If the top level source directory does not have @file{src-release}
> +(@value{GDBN} version 5.3.1 or earlier), try these commands instead.
>  
>  @smallexample
>  $  for m in gdb insight
> 
Andrew

Re: [rfa] gdb.texinfo: new release tarball commands

[Eli Zaretskii]

> Date: Fri, 10 Jan 2003 14:34:38 -0600
> From: Michael Elizabeth Chastain <mec@shout.net>
> 
> OK to apply?

Yes, but please make this small change before applying the patch:

> +If the top level source directory does not have @file{src-release}
> +(@value{GDBN} version 5.3.1 or earlier), try these commands instead.

Please end this sentence with a colon, not a period.

Thanks.

Re: [rfa] gdb.texinfo: new release tarball commands

[Eli Zaretskii]

> Date: Fri, 10 Jan 2003 16:54:47 -0600
> From: Michael Elizabeth Chastain <mec@shout.net>
> 
> Committed, with Eli Z's change of a period to a colon.
> 
> Michael C
> 
> 2003-01-09  Michael Chastain  <mec@shout.net>
> 
> 	* gdbint.texinfo (Configuring @value{GDBN} for Release): Delete.
> 	(Create a Release): Add new instructions for new @file{src-release}.
> 	Document existing instructions for @file{Makefile.in} as
> 	being for @value{GDBN} 5.3.1 or earlier.

It's not necessary to use @-commands in the ChangeLog entries.  In
fact, it might be confusing.

Btw, if "Configuring @value{GDBN} for Release" is the node name, it
should be avoided: using @-commands in node names confuses TeX and
might cause warnings from makeinfo.  But since this node was deleted,
I'm writing this just so we remember this in the future.

Thanks.

Re: [rfa] gdb.texinfo: new release tarball commands

[Michael Elizabeth Chastain]

Committed, with Eli Z's change of a period to a colon.

Michael C

2003-01-09  Michael Chastain  <mec@shout.net>

	* gdbint.texinfo (Configuring @value{GDBN} for Release): Delete.
	(Create a Release): Add new instructions for new @file{src-release}.
	Document existing instructions for @file{Makefile.in} as
	being for @value{GDBN} 5.3.1 or earlier.

Re: [rfa] gdb.texinfo: new release tarball commands

[Michael Elizabeth Chastain]

Okay I feel sufficiently approved now.  Commit comming,
with a colon, not a period.

Michael C

Re: [rfa] gdb.texinfo: new release tarball commands

[Michael Elizabeth Chastain]

Andrew C writes:
> I like it :-)

Err, is that an a-p-p-r-o-v-a-l, or should I wait for more feedback?

Michael C
cautious and pedantic