MatCat.OpenSource/8sa1-binutils-gdb
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

gdb/doc: move @menu blocks to the end of their enclosing @node

Browse Source 
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.
This commit is contained in:
Andrew Burgess 2021-01-22 18:55:11 +00:00
parent b8df69003d
commit 04de9f3e31
2 changed files with 44 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
gdb/doc/ChangeLog
View File

@ -1,3 +1,12 @@
2021-01-25 Andrew Burgess <andrew.burgess@embecosm.com>
* gdb.texinfo (Specify Location): Move menu to the end of the
node.
(Auto-loading): Likewise.
(Extending GDB): Likewise.
(TUI): Likewise.
(Operating System Information): Likewise.
2021-01-22 Andrew Burgess <andrew.burgess@embecosm.com> 2021-01-22 Andrew Burgess <andrew.burgess@embecosm.com>
PR cli/25956 PR cli/25956

70
gdb/doc/gdb.texinfo
View File

@ -8892,18 +8892,18 @@ As described in the preceding table.
@cindex location @cindex location
@cindex source 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 Several @value{GDBN} commands accept arguments that specify a location
of your program's code. Since @value{GDBN} is a source-level of your program's code. Since @value{GDBN} is a source-level
debugger, a location usually specifies some line in the source code. debugger, a location usually specifies some line in the source code.
Locations may be specified using three different formats: Locations may be specified using three different formats:
linespec locations, explicit locations, or address locations. 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 @node Linespec Locations
@subsection Linespec Locations @subsection Linespec Locations
@cindex linespec locations @cindex linespec locations
@ -25994,14 +25994,6 @@ without being explicitly told so by the user. We call this feature
results or introduce security risks (e.g., if the file comes from untrusted results or introduce security risks (e.g., if the file comes from untrusted
sources). 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. There are various kinds of files @value{GDBN} can automatically load.
In addition to these files, @value{GDBN} supports auto-loading code written In addition to these files, @value{GDBN} supports auto-loading code written
in various extension languages. @xref{Auto-loading extensions}. in various extension languages. @xref{Auto-loading extensions}.
@ -26123,6 +26115,14 @@ These are @value{GDBN} control commands for the auto-loading:
@tab Add directory trusted for automatic loading. @tab Add directory trusted for automatic loading.
@end multitable @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 @node Init File in the Current Directory
@subsection Automatically loading init file in the current directory @subsection Automatically loading init file in the current directory
@cindex auto-loading init file in the current directory @cindex auto-loading init file in the current directory
@ -26824,15 +26824,6 @@ extensions when it reads a file for debugging. This allows the
user to automatically customize @value{GDBN} for the program user to automatically customize @value{GDBN} for the program
being debugged. 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 To facilitate the use of extension languages, @value{GDBN} is capable
of evaluating the contents of a file. When doing so, @value{GDBN} of evaluating the contents of a file. When doing so, @value{GDBN}
can recognize which extension language is being used by looking at can recognize which extension language is being used by looking at
@ -26872,6 +26863,15 @@ or have a @file{.gdb} extension to be interpreted as regular @value{GDBN}
commands. @xref{Startup}. commands. @xref{Startup}.
@end ifset @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 @node Sequences
@section Canned Sequences of Commands @section Canned Sequences of Commands
@ -28064,14 +28064,6 @@ runs an MI interpreter on @file{/dev/pts/9}.
@cindex TUI @cindex TUI
@cindex Text User Interface @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 The @value{GDBN} Text User Interface (TUI) is a terminal
interface which uses the @code{curses} library to show the source interface which uses the @code{curses} library to show the source
file, the assembly output, the program registers and @value{GDBN} file, the assembly output, the program registers and @value{GDBN}
@ -28086,6 +28078,14 @@ using various TUI commands and key bindings, such as @command{tui
enable} or @kbd{C-x C-a}. @xref{TUI Commands, ,TUI Commands}, and enable} or @kbd{C-x C-a}. @xref{TUI Commands, ,TUI Commands}, and
@ref{TUI Keys, ,TUI Key Bindings}. @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 @node TUI Overview
@section TUI Overview @section TUI Overview
@ -46050,10 +46050,6 @@ contain registers @samp{TSR}, @samp{ILC} and @samp{RILC}.
@appendix Operating System Information @appendix Operating System Information
@cindex 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 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 the operating system running on the target---for example the list of
processes, or the list of open files. This section describes the processes, or the list of open files. This section describes the
@ -46066,6 +46062,10 @@ remote protocol, using @samp{qXfer} requests (@pxref{qXfer osdata
read}). The object name in the request should be @samp{osdata}, and read}). The object name in the request should be @samp{osdata}, and
the @var{annex} identifies the data to be fetched. the @var{annex} identifies the data to be fetched.
@menu
* Process list::
@end menu
@node Process list @node Process list
@appendixsection Process list @appendixsection Process list
@cindex operating system information, process list @cindex operating system information, process list