[PATCH] gdb/doc: move @menu blocks to the end of their enclosing @node
Andrew Burgess
andrew.burgess@embecosm.com
Fri Jan 22 19:04:55 GMT 2021
The @menus should be at the end of a @node. We mostly get this right,
but there's a few places where we don't. This commit fixes the 5
places we get this wrong.
I manually checked the info page and read each of the offending nodes
after this change and I believe they all still make sense with the
menu moved.
gdb/doc/ChangeLog:
* gdb.texinfo (Specify Location): Move menu to the end of the
node.
(Auto-loading): Likewise.
(Extending GDB): Likewise.
(TUI): Likewise.
(Operating System Information): Likewise.
---
gdb/doc/ChangeLog | 9 ++++++
gdb/doc/gdb.texinfo | 70 ++++++++++++++++++++++-----------------------
2 files changed, 44 insertions(+), 35 deletions(-)
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index f18b1c15224..8c7e979de96 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -8892,18 +8892,18 @@
@cindex location
@cindex source location
-@menu
-* Linespec Locations:: Linespec locations
-* Explicit Locations:: Explicit locations
-* Address Locations:: Address locations
-@end menu
-
Several @value{GDBN} commands accept arguments that specify a location
of your program's code. Since @value{GDBN} is a source-level
debugger, a location usually specifies some line in the source code.
Locations may be specified using three different formats:
linespec locations, explicit locations, or address locations.
+@menu
+* Linespec Locations:: Linespec locations
+* Explicit Locations:: Explicit locations
+* Address Locations:: Address locations
+@end menu
+
@node Linespec Locations
@subsection Linespec Locations
@cindex linespec locations
@@ -25982,14 +25982,6 @@
results or introduce security risks (e.g., if the file comes from untrusted
sources).
-@menu
-* Init File in the Current Directory:: @samp{set/show/info auto-load local-gdbinit}
-* libthread_db.so.1 file:: @samp{set/show/info auto-load libthread-db}
-
-* Auto-loading safe path:: @samp{set/show/info auto-load safe-path}
-* Auto-loading verbose mode:: @samp{set/show debug auto-load}
-@end menu
-
There are various kinds of files @value{GDBN} can automatically load.
In addition to these files, @value{GDBN} supports auto-loading code written
in various extension languages. @xref{Auto-loading extensions}.
@@ -26111,6 +26103,14 @@
@tab Add directory trusted for automatic loading.
@end multitable
+@menu
+* Init File in the Current Directory:: @samp{set/show/info auto-load local-gdbinit}
+* libthread_db.so.1 file:: @samp{set/show/info auto-load libthread-db}
+
+* Auto-loading safe path:: @samp{set/show/info auto-load safe-path}
+* Auto-loading verbose mode:: @samp{set/show debug auto-load}
+@end menu
+
@node Init File in the Current Directory
@subsection Automatically loading init file in the current directory
@cindex auto-loading init file in the current directory
@@ -26812,15 +26812,6 @@
user to automatically customize @value{GDBN} for the program
being debugged.
-@menu
-* Sequences:: Canned Sequences of @value{GDBN} Commands
-* Aliases:: Command Aliases
-* Python:: Extending @value{GDBN} using Python
-* Guile:: Extending @value{GDBN} using Guile
-* Auto-loading extensions:: Automatically loading extensions
-* Multiple Extension Languages:: Working with multiple extension languages
-@end menu
-
To facilitate the use of extension languages, @value{GDBN} is capable
of evaluating the contents of a file. When doing so, @value{GDBN}
can recognize which extension language is being used by looking at
@@ -26860,6 +26851,15 @@
commands. @xref{Startup}.
@end ifset
+@menu
+* Sequences:: Canned Sequences of @value{GDBN} Commands
+* Aliases:: Command Aliases
+* Python:: Extending @value{GDBN} using Python
+* Guile:: Extending @value{GDBN} using Guile
+* Auto-loading extensions:: Automatically loading extensions
+* Multiple Extension Languages:: Working with multiple extension languages
+@end menu
+
@node Sequences
@section Canned Sequences of Commands
@@ -28052,14 +28052,6 @@
@cindex TUI
@cindex Text User Interface
-@menu
-* TUI Overview:: TUI overview
-* TUI Keys:: TUI key bindings
-* TUI Single Key Mode:: TUI single key mode
-* TUI Commands:: TUI-specific commands
-* TUI Configuration:: TUI configuration variables
-@end menu
-
The @value{GDBN} Text User Interface (TUI) is a terminal
interface which uses the @code{curses} library to show the source
file, the assembly output, the program registers and @value{GDBN}
@@ -28074,6 +28066,14 @@
enable} or @kbd{C-x C-a}. @xref{TUI Commands, ,TUI Commands}, and
@ref{TUI Keys, ,TUI Key Bindings}.
+@menu
+* TUI Overview:: TUI overview
+* TUI Keys:: TUI key bindings
+* TUI Single Key Mode:: TUI single key mode
+* TUI Commands:: TUI-specific commands
+* TUI Configuration:: TUI configuration variables
+@end menu
+
@node TUI Overview
@section TUI Overview
@@ -46038,10 +46038,6 @@
@appendix Operating System Information
@cindex operating system information
-@menu
-* Process list::
-@end menu
-
Users of @value{GDBN} often wish to obtain information about the state of
the operating system running on the target---for example the list of
processes, or the list of open files. This section describes the
@@ -46054,6 +46050,10 @@
read}). The object name in the request should be @samp{osdata}, and
the @var{annex} identifies the data to be fetched.
+@menu
+* Process list::
+@end menu
+
@node Process list
@appendixsection Process list
@cindex operating system information, process list
--
2.25.4
More information about the Gdb-patches
mailing list