* [RFC 0/2] Allow ancient versions of makeinfo
@ 2023-08-30 16:26 Tom Tromey
2023-08-30 16:26 ` [RFC 1/2] Revert "Simplify @node use in BFD documentation" Tom Tromey
2023-08-30 16:26 ` [RFC 2/2] Remove libbfd.texi Tom Tromey
0 siblings, 2 replies; 6+ messages in thread
From: Tom Tromey @ 2023-08-30 16:26 UTC (permalink / raw)
To: binutils; +Cc: Nick Clifton
This short series tries to fix PR 30703, where old versions of
makeinfo don't work for BFD. I think the underlying cause is that the
BFD doc comments (and/or chew) haven't kept up with how texinfo is
expected to work. However, it seemed most straightforward to just
revert the offending patch.
Let me know what you think. I don't have the old makeinfo so I don't
actually know whether this patch is sufficient.
Tom
^ permalink raw reply [flat|nested] 6+ messages in thread
* [RFC 1/2] Revert "Simplify @node use in BFD documentation"
2023-08-30 16:26 [RFC 0/2] Allow ancient versions of makeinfo Tom Tromey
@ 2023-08-30 16:26 ` Tom Tromey
2023-08-30 22:44 ` Alan Modra
2023-08-30 16:26 ` [RFC 2/2] Remove libbfd.texi Tom Tromey
1 sibling, 1 reply; 6+ messages in thread
From: Tom Tromey @ 2023-08-30 16:26 UTC (permalink / raw)
To: binutils; +Cc: Nick Clifton, Tom Tromey
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
bfd/ChangeLog
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(-)
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
@contents
-@node Top
+@node Top, Overview, (dir), (dir)
@ifinfo
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
IEEE-695.
-@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
@menu
@@ -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
structures.
-@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
@menu
* 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
@url{https://github.com/WebAssembly/design/blob/master/BinaryEncoding.md}.
--
2.41.0
^ permalink raw reply [flat|nested] 6+ messages in thread
* [RFC 2/2] Remove libbfd.texi
2023-08-30 16:26 [RFC 0/2] Allow ancient versions of makeinfo Tom Tromey
2023-08-30 16:26 ` [RFC 1/2] Revert "Simplify @node use in BFD documentation" Tom Tromey
@ 2023-08-30 16:26 ` Tom Tromey
2023-08-30 22:46 ` Alan Modra
1 sibling, 1 reply; 6+ messages in thread
From: Tom Tromey @ 2023-08-30 16:26 UTC (permalink / raw)
To: binutils; +Cc: Nick Clifton, Tom Tromey
While paging through the BFD manual, I noticed that the "Internals"
node is completely empty. This patch removes it.
bfd/ChangeLog
2023-08-30 Tom Tromey <tom@tromey.com>
* doc/local.mk (DOCFILES): Remove libbfd.texi.
* Makefile.in: Regenerate.
* doc/bfd.texi (Internal): Remove node.
---
bfd/ChangeLog | 6 ++++++
bfd/Makefile.in | 1 -
bfd/doc/bfd.texi | 8 ++------
bfd/doc/local.mk | 1 -
4 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/bfd/Makefile.in b/bfd/Makefile.in
index bb530271fca..20333403e38 100644
--- a/bfd/Makefile.in
+++ b/bfd/Makefile.in
@@ -1251,7 +1251,6 @@ DOCFILES = \
doc/elf.texi \
doc/format.texi \
doc/hash.texi \
- doc/libbfd.texi \
doc/linker.texi \
doc/mmo.texi \
doc/opncls.texi \
diff --git a/bfd/doc/bfd.texi b/bfd/doc/bfd.texi
index f348710845f..07b688e31ff 100644
--- a/bfd/doc/bfd.texi
+++ b/bfd/doc/bfd.texi
@@ -210,7 +210,6 @@ IEEE-695.
* Targets::
* Architectures::
* Opening and Closing::
-* Internal::
* File Caching::
* Linker Functions::
* Hash Tables::
@@ -266,13 +265,10 @@ structures.
@node Architectures, Opening and Closing, Targets, BFD front end
@include archures.texi
-@node Opening and Closing, Internal, Architectures, BFD front end
+@node Opening and Closing, File Caching, Architectures, BFD front end
@include opncls.texi
-@node Internal, File Caching, Opening and Closing, BFD front end
-@include libbfd.texi
-
-@node File Caching, Linker Functions, Internal, BFD front end
+@node File Caching, Linker Functions, Opening and Closing, BFD front end
@include cache.texi
@node Linker Functions, Hash Tables, File Caching, BFD front end
diff --git a/bfd/doc/local.mk b/bfd/doc/local.mk
index d80f70416a3..d81347d049c 100644
--- a/bfd/doc/local.mk
+++ b/bfd/doc/local.mk
@@ -32,7 +32,6 @@ DOCFILES = \
%D%/elf.texi \
%D%/format.texi \
%D%/hash.texi \
- %D%/libbfd.texi \
%D%/linker.texi \
%D%/mmo.texi \
%D%/opncls.texi \
--
2.41.0
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [RFC 1/2] Revert "Simplify @node use in BFD documentation"
2023-08-30 16:26 ` [RFC 1/2] Revert "Simplify @node use in BFD documentation" Tom Tromey
@ 2023-08-30 22:44 ` Alan Modra
0 siblings, 0 replies; 6+ messages in thread
From: Alan Modra @ 2023-08-30 22:44 UTC (permalink / raw)
To: Tom Tromey; +Cc: binutils
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.
Thanks.
--
Alan Modra
Australia Development Lab, IBM
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [RFC 2/2] Remove libbfd.texi
2023-08-30 16:26 ` [RFC 2/2] Remove libbfd.texi Tom Tromey
@ 2023-08-30 22:46 ` Alan Modra
2023-08-30 22:56 ` Alan Modra
0 siblings, 1 reply; 6+ messages in thread
From: Alan Modra @ 2023-08-30 22:46 UTC (permalink / raw)
To: Tom Tromey; +Cc: binutils
On Wed, Aug 30, 2023 at 10:26:33AM -0600, Tom Tromey wrote:
> While paging through the BFD manual, I noticed that the "Internals"
> node is completely empty. This patch removes it.
>
> bfd/ChangeLog
> 2023-08-30 Tom Tromey <tom@tromey.com>
>
> * doc/local.mk (DOCFILES): Remove libbfd.texi.
> * Makefile.in: Regenerate.
> * doc/bfd.texi (Internal): Remove node.
Please don't commit this one. We ought to be getting some info,
starting with the bfd_malloc description. I'll see if I can figure
out why chew is misbehaving.
--
Alan Modra
Australia Development Lab, IBM
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [RFC 2/2] Remove libbfd.texi
2023-08-30 22:46 ` Alan Modra
@ 2023-08-30 22:56 ` Alan Modra
0 siblings, 0 replies; 6+ messages in thread
From: Alan Modra @ 2023-08-30 22:56 UTC (permalink / raw)
To: Tom Tromey; +Cc: binutils
On Thu, Aug 31, 2023 at 08:16:53AM +0930, Alan Modra wrote:
> On Wed, Aug 30, 2023 at 10:26:33AM -0600, Tom Tromey wrote:
> > While paging through the BFD manual, I noticed that the "Internals"
> > node is completely empty. This patch removes it.
> >
> > bfd/ChangeLog
> > 2023-08-30 Tom Tromey <tom@tromey.com>
> >
> > * doc/local.mk (DOCFILES): Remove libbfd.texi.
> > * Makefile.in: Regenerate.
> > * doc/bfd.texi (Internal): Remove node.
>
> Please don't commit this one. We ought to be getting some info,
> starting with the bfd_malloc description. I'll see if I can figure
> out why chew is misbehaving.
It's a makefile problem with pattern rules in bfd/doc/local.mk.
--
Alan Modra
Australia Development Lab, IBM
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2023-08-30 22:56 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-08-30 16:26 [RFC 0/2] Allow ancient versions of makeinfo Tom Tromey
2023-08-30 16:26 ` [RFC 1/2] Revert "Simplify @node use in BFD documentation" Tom Tromey
2023-08-30 22:44 ` Alan Modra
2023-08-30 16:26 ` [RFC 2/2] Remove libbfd.texi Tom Tromey
2023-08-30 22:46 ` Alan Modra
2023-08-30 22:56 ` Alan Modra
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).