From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: by sourceware.org (Postfix, from userid 2126) id CDCE53858C60; Wed, 15 Feb 2023 17:28:25 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org CDCE53858C60 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Tom Tromey To: bfd-cvs@sourceware.org Subject: [binutils-gdb] Simplify @node use in BFD documentation X-Act-Checkin: binutils-gdb X-Git-Author: Tom Tromey X-Git-Refname: refs/heads/master X-Git-Oldrev: 1cbeca4aa604cdbdc17a5e88a4f4a864fef8421c X-Git-Newrev: 8bb23cdbb498ff645bb0937bc8c0cb89e9e5ebd8 Message-Id: <20230215172825.CDCE53858C60@sourceware.org> Date: Wed, 15 Feb 2023 17:28:25 +0000 (GMT) X-BeenThere: binutils-cvs@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Binutils-cvs mailing list List-Unsubscribe: , List-Archive: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 15 Feb 2023 17:28:25 -0000 https://sourceware.org/git/gitweb.cgi?p=3Dbinutils-gdb.git;h=3D8bb23cdbb498= ff645bb0937bc8c0cb89e9e5ebd8 commit 8bb23cdbb498ff645bb0937bc8c0cb89e9e5ebd8 Author: Tom Tromey Date: Tue Feb 7 11:34:56 2023 -0700 Simplify @node use in BFD documentation =20 The BFD docs currently specify all the parameters to @node. However, this results in bad navigation in certain nodes -- the "space" command in info doesn't know how to find the next node. =20 I think this style of @node is a leftover from ancient times. Makeinfo can figure out the node structure on its own now, so simplify everything to a single-argument @node. =20 2023-02-07 Tom Tromey =20 * doc/webassembly.texi (File layout): Remove second argument fr= om @node. * doc/bfd.texi: Use single-argument @node everywhere. Diff: --- bfd/ChangeLog | 6 ++++++ bfd/doc/bfd.texi | 56 ++++++++++++++++++++++++--------------------= ---- bfd/doc/webassembly.texi | 2 +- 3 files changed, 35 insertions(+), 29 deletions(-) diff --git a/bfd/ChangeLog b/bfd/ChangeLog index 570367745c3..bb1cbe82adf 100644 --- a/bfd/ChangeLog +++ b/bfd/ChangeLog @@ -1,3 +1,9 @@ +2023-02-07 Tom Tromey + + * doc/webassembly.texi (File layout): Remove second argument from + @node. + * doc/bfd.texi: Use single-argument @node everywhere. + 2023-02-07 Tom Tromey =20 * Makefile.in: Rebuild. diff --git a/bfd/doc/bfd.texi b/bfd/doc/bfd.texi index f348710845f..d8cc1ecca48 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 @contents =20 -@node Top, Overview, (dir), (dir) +@node Top @ifinfo This file documents the binary file descriptor library libbfd. @end ifinfo @@ -88,7 +88,7 @@ This file documents the binary file descriptor library li= bbfd. * BFD Index:: BFD Index @end menu =20 -@node Overview, BFD front end, Top, Top +@node Overview @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 =20 -@node History, How It Works, Overview, Overview +@node History @section History =20 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}). =20 =20 =20 -@node How It Works, What BFD Version 2 Can Do, History, Overview +@node How It Works @section How To Use BFD =20 To use the library, include @file{bfd.h} and link with @file{libbfd.a}.=09 @@ -188,11 +188,11 @@ and contain subordinate BFDs. This approach is fine f= or a.out and coff, but loses efficiency when applied to formats such as S-records and IEEE-695. =20 -@node What BFD Version 2 Can Do, , How It Works, Overview +@node What BFD Version 2 Can Do @section What BFD Version 2 Can Do @include bfdsumm.texi =20 -@node BFD front end, BFD back ends, Overview, Top +@node BFD front end @chapter BFD Front End =20 @menu @@ -219,7 +219,7 @@ IEEE-695. @include bfdt.texi @include bfdio.texi =20 -@node Memory Usage, Sections, Miscellaneous, BFD front end +@node Memory Usage @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 th= e memory, perform some operation and reopen the BFD again, to get a fresh copy of the data structures. =20 -@node Sections, Symbols, Memory Usage, BFD front end +@node Sections @include section.texi =20 -@node Symbols, Archives, Sections, BFD front end +@node Symbols @include syms.texi =20 -@node Archives, Formats, Symbols, BFD front end +@node Archives @include archive.texi =20 -@node Formats, Relocations, Archives, BFD front end +@node Formats @include format.texi =20 -@node Relocations, Core Files, Formats, BFD front end +@node Relocations @include reloc.texi =20 -@node Core Files, Targets, Relocations, BFD front end +@node Core Files @include corefile.texi =20 -@node Targets, Architectures, Core Files, BFD front end +@node Targets @include targets.texi =20 -@node Architectures, Opening and Closing, Targets, BFD front end +@node Architectures @include archures.texi =20 -@node Opening and Closing, Internal, Architectures, BFD front end +@node Opening and Closing @include opncls.texi =20 -@node Internal, File Caching, Opening and Closing, BFD front end +@node Internal @include libbfd.texi =20 -@node File Caching, Linker Functions, Internal, BFD front end +@node File Caching @include cache.texi =20 -@node Linker Functions, Hash Tables, File Caching, BFD front end +@node Linker Functions @include linker.texi =20 -@node Hash Tables, , Linker Functions, BFD front end +@node Hash Tables @include hash.texi =20 -@node BFD back ends, GNU Free Documentation License, BFD front end, Top +@node BFD back ends @chapter BFD back ends @menu * What to Put Where:: @@ -293,28 +293,28 @@ structures. * srecord :: s-record backend @end ignore @end menu -@node What to Put Where, aout, BFD back ends, BFD back ends +@node What to Put Where @section What to Put Where All of BFD lives in one directory. =20 -@node aout, coff, What to Put Where, BFD back ends +@node aout @include aoutx.texi =20 -@node coff, elf, aout, BFD back ends +@node coff @include coffcode.texi =20 -@node elf, mmo, coff, BFD back ends +@node elf @include elf.texi @c Leave this out until the file has some actual contents... @c @include elfcode.texi =20 -@node mmo, , elf, BFD back ends +@node mmo @include mmo.texi =20 -@node GNU Free Documentation License, BFD Index, BFD back ends, Top +@node GNU Free Documentation License @include fdl.texi =20 -@node BFD Index, , GNU Free Documentation License, Top +@node BFD Index @unnumbered BFD Index @printindex cp =20 diff --git a/bfd/doc/webassembly.texi b/bfd/doc/webassembly.texi index ad650943a1a..5a05199d5f7 100644 --- a/bfd/doc/webassembly.texi +++ b/bfd/doc/webassembly.texi @@ -27,7 +27,7 @@ in some malformed WebAssembly modules being treated as va= lid. * File layout:: @end menu =20 -@node File layout, WebAssembly +@node File layout @subsection File layout For a description of the WebAssembly file format, see @url{https://github.com/WebAssembly/design/blob/master/BinaryEncoding.md}.