[RFC,1/2] Revert "Simplify @node use in BFD documentation"

Message ID 20230830162836.2257576-2-tom@tromey.com
State New
Series Allow ancient versions of makeinfo |


Context Check Description
linaro-tcwg-bot/tcwg_binutils_build--master-arm success Testing passed
linaro-tcwg-bot/tcwg_binutils_build--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_binutils_check--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_binutils_check--master-arm success Testing passed

Commit Message

Tom Tromey Aug. 30, 2023, 4:26 p.m. UTC
  This reverts commit 8bb23cdbb498ff645bb0937bc8c0cb89e9e5ebd8.

My earlier patch to simplifify the @node uses in the BFD manual didn't
take into account (1) that BFD doesn't use the ordinary texinfo
sectioning commands, and (2) that some users are stuck on very ancient
versions of makeinfo.

This patch reverts the change.

I went through the entire manual using the spacebar, trying to find
the original problem I reported in the change, but couldn't.  I don't
know why.  Anyway, all this means is that, with this reversion,
editing the node structure will be slightly less convenient.

Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=30703

2023-08-30  Tom Tromey  <tom@tromey.com>

	PR binutils/30703
	* doc/webassembly.texi, doc/bfd.texi: Revert 8bb23cdb, adding
	parameters back to @node.
 bfd/ChangeLog            |  6 +++++
 bfd/doc/bfd.texi         | 56 ++++++++++++++++++++--------------------
 bfd/doc/webassembly.texi |  2 +-
 3 files changed, 35 insertions(+), 29 deletions(-)


Alan Modra Aug. 30, 2023, 10:44 p.m. UTC | #1
On Wed, Aug 30, 2023 at 10:26:32AM -0600, Tom Tromey wrote:
> 	PR binutils/30703
> 	* doc/webassembly.texi, doc/bfd.texi: Revert 8bb23cdb, adding
> 	parameters back to @node.



diff --git a/bfd/doc/bfd.texi b/bfd/doc/bfd.texi
index d8cc1ecca48..f348710845f 100644
--- a/bfd/doc/bfd.texi
+++ b/bfd/doc/bfd.texi
@@ -75,7 +75,7 @@  Copyright @copyright{} 1991-2023 Free Software Foundation, Inc.
 @end iftex
-@node Top
+@node Top, Overview, (dir), (dir)
 This file documents the binary file descriptor library libbfd.
 @end ifinfo
@@ -88,7 +88,7 @@  This file documents the binary file descriptor library libbfd.
 * BFD Index::		BFD Index
 @end menu
-@node Overview
+@node Overview, BFD front end, Top, Top
 @chapter Introduction
 @cindex BFD
 @cindex what is it?
@@ -114,7 +114,7 @@  their own use, for greater efficiency.
 * What BFD Version 2 Can Do::	What BFD Version 2 Can Do
 @end menu
-@node History
+@node History, How It Works, Overview, Overview
 @section History
 One spur behind BFD was the desire, on the part of the GNU 960 team at
@@ -137,7 +137,7 @@  and David Henkel-Wallace (@code{gumby@@cygnus.com}).
-@node How It Works
+@node How It Works, What BFD Version 2 Can Do, History, Overview
 @section How To Use BFD
 To use the library, include @file{bfd.h} and link with @file{libbfd.a}.	
@@ -188,11 +188,11 @@  and contain subordinate BFDs. This approach is fine for a.out and coff,
 but loses efficiency when applied to formats such as S-records and
-@node What BFD Version 2 Can Do
+@node What BFD Version 2 Can Do,  , How It Works, Overview
 @section What BFD Version 2 Can Do
 @include bfdsumm.texi
-@node BFD front end
+@node BFD front end, BFD back ends, Overview, Top
 @chapter BFD Front End
@@ -219,7 +219,7 @@  IEEE-695.
 @include bfdt.texi
 @include bfdio.texi
-@node Memory Usage
+@node Memory Usage, Sections, Miscellaneous, BFD front end
 @section Memory Usage
 BFD keeps all of its internal structures in obstacks. There is one obstack
 per open BFD file, into which the current state is stored. When a BFD is
@@ -242,46 +242,46 @@  select the greediest open BFD, close it to reclaim the memory, perform
 some operation and reopen the BFD again, to get a fresh copy of the data
-@node Sections
+@node Sections, Symbols, Memory Usage, BFD front end
 @include  section.texi
-@node Symbols
+@node Symbols, Archives, Sections, BFD front end
 @include  syms.texi
-@node Archives
+@node Archives, Formats, Symbols, BFD front end
 @include  archive.texi
-@node Formats
+@node Formats, Relocations, Archives, BFD front end
 @include  format.texi
-@node Relocations
+@node Relocations, Core Files, Formats, BFD front end
 @include  reloc.texi
-@node Core Files
+@node Core Files, Targets, Relocations, BFD front end
 @include  corefile.texi
-@node Targets
+@node Targets, Architectures, Core Files, BFD front end
 @include  targets.texi
-@node Architectures
+@node Architectures, Opening and Closing, Targets, BFD front end
 @include  archures.texi
-@node Opening and Closing
+@node Opening and Closing, Internal, Architectures, BFD front end
 @include  opncls.texi
-@node Internal
+@node Internal, File Caching, Opening and Closing, BFD front end
 @include  libbfd.texi
-@node File Caching
+@node File Caching, Linker Functions, Internal, BFD front end
 @include  cache.texi
-@node Linker Functions
+@node Linker Functions, Hash Tables, File Caching, BFD front end
 @include  linker.texi
-@node Hash Tables
+@node Hash Tables, , Linker Functions, BFD front end
 @include  hash.texi
-@node BFD back ends
+@node BFD back ends, GNU Free Documentation License, BFD front end, Top
 @chapter BFD back ends
 * What to Put Where::
@@ -293,28 +293,28 @@  structures.
 * srecord ::	s-record backend
 @end ignore
 @end menu
-@node What to Put Where
+@node What to Put Where, aout, BFD back ends, BFD back ends
 @section What to Put Where
 All of BFD lives in one directory.
-@node aout
+@node aout, coff, What to Put Where, BFD back ends
 @include  aoutx.texi
-@node coff
+@node coff, elf, aout, BFD back ends
 @include  coffcode.texi
-@node elf
+@node elf, mmo, coff, BFD back ends
 @include  elf.texi
 @c Leave this out until the file has some actual contents...
 @c @include  elfcode.texi
-@node mmo
+@node mmo,  , elf, BFD back ends
 @include  mmo.texi
-@node GNU Free Documentation License
+@node GNU Free Documentation License, BFD Index, BFD back ends, Top
 @include fdl.texi
-@node BFD Index
+@node BFD Index,  , GNU Free Documentation License, Top
 @unnumbered BFD Index
 @printindex cp
diff --git a/bfd/doc/webassembly.texi b/bfd/doc/webassembly.texi
index 5a05199d5f7..ad650943a1a 100644
--- a/bfd/doc/webassembly.texi
+++ b/bfd/doc/webassembly.texi
@@ -27,7 +27,7 @@  in some malformed WebAssembly modules being treated as valid.
 * File layout::
 @end menu
-@node File layout
+@node File layout, WebAssembly
 @subsection File layout
 For a description of the WebAssembly file format, see