[rfa:doco, 6.0] (C) and other fixes

[rfa:doco, 6.0] (C) and other fixes

[Andrew Cagney]

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

Hello,

This little audit fixes a number of problems in the current doco:

- gdbint.texinfo and stabs.texinfo didn't have correct invariant statements

- stabs.texinfo didn't include the FDL

- a stray @bye in agentexpr.texi caused the main manual to loose several 
appendixes and the index :-(

- s/annotate.html/annotate_toc.html/.

ok, 6.0?

Andrew

[-- Attachment #2: diffs --]
[-- Type: text/plain, Size: 6080 bytes --]

2003-08-04  Andrew Cagney  <cagney@redhat.com>

	* agentexpr.texi: Delete @bye.
	* Makefile.in (STABS_DOC_SOURCE_INCLUDES): Add "fdl.texi"
	(stabs.info): Add $(srcdir) to include search path.
	(html): Depend on "annotate_toc.html", and not "annotate.html".
	* stabs.texinfo: Ditto.  Include "fdl.texi".
	* gdbint.texinfo: Update copyright statement's list of invariant
	sections.

Index: Makefile.in
===================================================================
RCS file: /cvs/src/src/gdb/doc/Makefile.in,v
retrieving revision 1.31
diff -u -r1.31 Makefile.in
--- Makefile.in	30 Jul 2003 04:14:38 -0000	1.31
+++ Makefile.in	4 Aug 2003 16:07:09 -0000
@@ -124,7 +124,8 @@
 	$(GDBINT_DOC_BUILD_INCLUDES)
 
 # Stabs manual: All files
-STABS_DOC_SOURCE_INCLUDES =
+STABS_DOC_SOURCE_INCLUDES = \
+	$(srcdir)/fdl.texi
 STABS_DOC_BUILD_INCLUDES =
 STABS_DOC_FILES = \
 	$(srcdir)/stabs.texinfo \
@@ -149,7 +150,7 @@
 info: $(INFO_DEPS)
 dvi: gdb.dvi gdbint.dvi stabs.dvi refcard.dvi annotate.dvi
 ps: gdb.ps gdbint.ps stabs.ps refcard.ps annotate.ps
-html: gdb_toc.html gdbint_toc.html stabs_toc.html annotate.html
+html: gdb_toc.html gdbint_toc.html stabs_toc.html annotate_toc.html
 pdf: gdb.pdf gdbint.pdf stabs.pdf annotate.pdf
 all-doc: info dvi ps # pdf
 diststuff: info
@@ -405,7 +406,7 @@
 	$(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/gdbint.texinfo
 
 stabs.info: $(STABS_DOC_FILES)
-	$(MAKEINFO) -o stabs.info $(srcdir)/stabs.texinfo
+	$(MAKEINFO) -I $(srcdir) -o stabs.info $(srcdir)/stabs.texinfo
 
 # STABS DOCUMENTATION: HTML file
 
Index: agentexpr.texi
===================================================================
RCS file: /cvs/src/src/gdb/doc/agentexpr.texi,v
retrieving revision 1.4
diff -u -r1.4 agentexpr.texi
--- agentexpr.texi	22 Jun 2003 04:27:24 -0000	1.4
+++ agentexpr.texi	4 Aug 2003 16:07:10 -0000
@@ -835,5 +835,3 @@
 it.
 
 @end table
-
-@bye
Index: gdbint.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdbint.texinfo,v
retrieving revision 1.157
diff -u -r1.157 gdbint.texinfo
--- gdbint.texinfo	24 Jul 2003 18:56:37 -0000	1.157
+++ gdbint.texinfo	4 Aug 2003 16:07:13 -0000
@@ -16,12 +16,9 @@
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.1 or
 any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
-and with the Back-Cover Texts as in (a) below.
-
-(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
-this GNU Manual, like GNU software.  Copies published by the Free
-Software Foundation raise funds for GNU development.''
+Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
+Texts.  A copy of the license is included in the section entitled ``GNU
+Free Documentation License''.
 @end ifinfo
 
 @setchapternewpage off
@@ -56,12 +53,9 @@
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.1 or
 any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
-and with the Back-Cover Texts as in (a) below.
-
-(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
-this GNU Manual, like GNU software.  Copies published by the Free
-Software Foundation raise funds for GNU development.''
+Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
+Texts.  A copy of the license is included in the section entitled ``GNU
+Free Documentation License''.
 @end titlepage
 
 @contents
Index: stabs.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/stabs.texinfo,v
retrieving revision 1.10
diff -u -r1.10 stabs.texinfo
--- stabs.texinfo	3 Mar 2003 23:16:27 -0000	1.10
+++ stabs.texinfo	4 Aug 2003 16:07:15 -0000
@@ -22,12 +22,9 @@
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.1 or
 any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
-and with the Back-Cover Texts as in (a) below.
-
-(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
-this GNU Manual, like GNU software.  Copies published by the Free
-Software Foundation raise funds for GNU development.''
+Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
+Texts.  A copy of the license is included in the section entitled ``GNU
+Free Documentation License''.
 @end ifinfo
 
 @setchapternewpage odd
@@ -54,13 +51,9 @@
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.1 or
 any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
-and with the Back-Cover Texts as in (a) below.
-
-(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
-this GNU Manual, like GNU software.  Copies published by the Free
-Software Foundation raise funds for GNU development.''
-
+Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
+Texts.  A copy of the license is included in the section entitled ``GNU
+Free Documentation License''.
 @end titlepage
 
 @ifinfo
@@ -85,6 +78,7 @@
 * Stab Sections::		In some object file formats, stabs are
                                 in sections.
 * Symbol Types Index::          Index of symbolic stab symbol type names.
+* GNU Free Documentation License::  The license for this documentation
 @end menu
 @end ifinfo
 
@@ -4032,6 +4026,8 @@
 is no more work than having the linker relocate ELF symbols, and it
 solves the problem of having to associate the ELF and stab symbols.
 However, no one has yet designed or implemented such a scheme.
+
+@include fdl.texi
 
 @node Symbol Types Index
 @unnumbered Symbol Types Index

Re: [rfa:doco, 6.0] (C) and other fixes

[Daniel Jacobowitz]

On Mon, Aug 04, 2003 at 12:11:44PM -0400, Andrew Cagney wrote:
> Hello,
> 
> This little audit fixes a number of problems in the current doco:
> 
> - gdbint.texinfo and stabs.texinfo didn't have correct invariant statements
> 
> - stabs.texinfo didn't include the FDL
> 
> - a stray @bye in agentexpr.texi caused the main manual to loose several 
> appendixes and the index :-(

Oh!  _Thanks_ for figuring out what was wrong.  I built a pdf the other
day, noticed it didn't have an index, and foolishly assumed it hadn't
had one the last time either...

-- 
Daniel Jacobowitz
MontaVista Software                         Debian GNU/Linux Developer

Re: [rfa:doco, 6.0] (C) and other fixes

[Andrew Cagney]

> On Mon, Aug 04, 2003 at 12:11:44PM -0400, Andrew Cagney wrote:
> 
>> Hello,
>> 
>> This little audit fixes a number of problems in the current doco:
>> 
>> - gdbint.texinfo and stabs.texinfo didn't have correct invariant statements
>> 
>> - stabs.texinfo didn't include the FDL
>> 
>> - a stray @bye in agentexpr.texi caused the main manual to loose several 
>> appendixes and the index :-(
> 
> 
> Oh!  _Thanks_ for figuring out what was wrong.  I built a pdf the other
> day, noticed it didn't have an index, and foolishly assumed it hadn't
> had one the last time either...

Several releases back GDB was shipped with a broken index so ever since 
then I've kept an eye out.

I think, though, that there is a makeinfo bug here.  It should have 
reported an error due to references to missing sections.

Andrew

Re: [rfa:doco, 6.0] (C) and other fixes

[Eli Zaretskii]

> Date: Thu, 07 Aug 2003 00:24:22 -0400
> From: Andrew Cagney <ac131313@redhat.com>
> 
> I think, though, that there is a makeinfo bug here.  It should have 
> reported an error due to references to missing sections.

What references were pointing to the missing sections?

Re: [rfa:doco, 6.0] (C) and other fixes

[Andrew Cagney]

> Date: Thu, 07 Aug 2003 00:24:22 -0400
>> From: Andrew Cagney <ac131313@redhat.com>
>> 
>> I think, though, that there is a makeinfo bug here.  It should have 
>> reported an error due to references to missing sections.
> 
> 
> What references were pointing to the missing sections?

If I add @bye to the end of agentexpr.texi "make info" runs cleanly and 
the document looks ok (the @bye appears to be ignored).  However, if the 
@bye is put in gdb.texinfo just after the @include agentexpr.texi, or if 
@bye is put at the start of agentexpr.texi, "make info" gets errors 
about undefined references to "Copying", "Index" and "GNU Free ...".

TeX, on the other hand `dies a death' in both cases (which is what I'd 
expect makeinfo to do).

This is with makeinfo 4.6.

enjoy,
Andrew

Re: [rfa:doco, 6.0] (C) and other fixes

[Eli Zaretskii]

> Date: Thu, 07 Aug 2003 17:35:58 -0400
> From: Andrew Cagney <ac131313@redhat.com>
> >> 
> >> I think, though, that there is a makeinfo bug here.  It should have 
> >> reported an error due to references to missing sections.
> > 
> > 
> > What references were pointing to the missing sections?
> 
> If I add @bye to the end of agentexpr.texi "make info" runs cleanly and 
> the document looks ok (the @bye appears to be ignored).  However, if the 
> @bye is put in gdb.texinfo just after the @include agentexpr.texi, or if 
> @bye is put at the start of agentexpr.texi, "make info" gets errors 
> about undefined references to "Copying", "Index" and "GNU Free ...".
> 
> TeX, on the other hand `dies a death' in both cases (which is what I'd 
> expect makeinfo to do).

I'm confused: where is the bug in makeinfo that you thought about?
AFAIU, makeinfo behaves correctly: produces a valid Info document in
the first case and complains about the second.

Re: [rfa:doco, 6.0] (C) and other fixes

[Andrew Cagney]

>> Date: Thu, 07 Aug 2003 17:35:58 -0400
>> From: Andrew Cagney <ac131313@redhat.com>
> 
>> >> 
>> >> I think, though, that there is a makeinfo bug here.  It should have 
>> >> reported an error due to references to missing sections.
> 
>> > 
>> > 
>> > What references were pointing to the missing sections?
> 
>> 
>> If I add @bye to the end of agentexpr.texi "make info" runs cleanly and 
>> the document looks ok (the @bye appears to be ignored).  However, if the 
>> @bye is put in gdb.texinfo just after the @include agentexpr.texi, or if 
>> @bye is put at the start of agentexpr.texi, "make info" gets errors 
>> about undefined references to "Copying", "Index" and "GNU Free ...".
>> 
>> TeX, on the other hand `dies a death' in both cases (which is what I'd 
>> expect makeinfo to do).
> 
> 
> I'm confused: where is the bug in makeinfo that you thought about?
> AFAIU, makeinfo behaves correctly: produces a valid Info document in
> the first case and complains about the second.

It should complain in all cases.  For some strange reason makeinfo 
silently ignores @bye as the last line of an included file (well at 
least the file agentexpr.texi). texinfo doesn't do this.  @include mentions:

> Likewise, you should not end an included file with an
> `@bye' command; nothing after `@bye' is formatted.

enjoy,
Andrew

Re: [rfa:doco, 6.0] (C) and other fixes

[Eli Zaretskii]

> Date: Mon, 04 Aug 2003 12:11:44 -0400
> From: Andrew Cagney <ac131313@redhat.com>
> 
> This little audit fixes a number of problems in the current doco:
> 
> - gdbint.texinfo and stabs.texinfo didn't have correct invariant statements
> 
> - stabs.texinfo didn't include the FDL
> 
> - a stray @bye in agentexpr.texi caused the main manual to loose several
> appendixes and the index :-(
> 
> - s/annotate.html/annotate_toc.html/.
> 
> ok, 6.0?

Yes, okay.

Re: [rfa:doco, 6.0] (C) and other fixes

[Andrew Cagney]

>> Date: Mon, 04 Aug 2003 12:11:44 -0400
>> From: Andrew Cagney <ac131313@redhat.com>
>> 
>> This little audit fixes a number of problems in the current doco:
>> 
>> - gdbint.texinfo and stabs.texinfo didn't have correct invariant statements
>> 
>> - stabs.texinfo didn't include the FDL
>> 
>> - a stray @bye in agentexpr.texi caused the main manual to loose several
>> appendixes and the index :-(
>> 
>> - s/annotate.html/annotate_toc.html/.
>> 
>> ok, 6.0?
> 
> 
> Yes, okay.

In!

Andrew