* [PATCH 0/5] gdb/doc: a series of doc clean ups
@ 2026-10-12 18:54 Andrew Burgess
2026-10-12 18:54 ` [PATCH 1/5] gdb/doc: use (@value{GDBP}) for the prompt in examples Andrew Burgess
` (4 more replies)
0 siblings, 5 replies; 12+ messages in thread
From: Andrew Burgess @ 2026-10-12 18:54 UTC (permalink / raw)
To: gdb-patches; +Cc: Andrew Burgess
This is mostly about using the correct @WORD wrapper in more places.
The GDB docs tend to overuse @code{...} and @samp{...} when there are
better choices available.
There's also a patch related to how we format on/off choices in
command help text.
There's probably a lot more stuff that can be cleaned up in the docs,
but I thought I'd see how this goes to begin with.
Thanks,
Andrew
---
Andrew Burgess (5):
gdb/doc: use (@value{GDBP}) for the prompt in examples
gdb/doc: fix some incorrect '@table @code' uses
gdb/doc: consistent formatting for on|off on @item lines
gdb/doc: make more use of @option{...} formatting
gdb/doc: more @command and @kbd
gdb/doc/gdb.texinfo | 1820 +++++++++++++++++++++----------------------
gdb/doc/guile.texi | 64 +-
gdb/doc/python.texi | 58 +-
3 files changed, 971 insertions(+), 971 deletions(-)
base-commit: b7ee9065ecd249773b7d582eee723686fc58dd5d
--
2.55.0
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH 1/5] gdb/doc: use (@value{GDBP}) for the prompt in examples
2026-10-12 18:54 [PATCH 0/5] gdb/doc: a series of doc clean ups Andrew Burgess
@ 2026-10-12 18:54 ` Andrew Burgess
2026-10-13 11:43 ` Eli Zaretskii
2026-10-12 18:54 ` [PATCH 2/5] gdb/doc: fix some incorrect '@table @code' uses Andrew Burgess
` (3 subsequent siblings)
4 siblings, 1 reply; 12+ messages in thread
From: Andrew Burgess @ 2026-10-12 18:54 UTC (permalink / raw)
To: gdb-patches; +Cc: Andrew Burgess
Within examples we should be using (@value{GDBP}) not '(gdb)'. There
are several places where we don't do this, fix them now.
---
gdb/doc/gdb.texinfo | 648 ++++++++++++++++++++++----------------------
gdb/doc/guile.texi | 50 ++--
gdb/doc/python.texi | 38 +--
3 files changed, 368 insertions(+), 368 deletions(-)
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 4bd5357c587..1f7778a1824 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -4764,9 +4764,9 @@ Set Breaks
@code{b}). The debugger convenience variable @samp{$bpnum} records the
number of the breakpoint you've set most recently:
@smallexample
-(gdb) b main
+(@value{GDBP}) b main
Breakpoint 1 at 0x11c6: file zeoes.c, line 24.
-(gdb) p $bpnum
+(@value{GDBP}) p $bpnum
$1 = 1
@end smallexample
@@ -4775,11 +4775,11 @@ Set Breaks
@value{GDBN} then indicates the number of code locations in the breakpoint
command output:
@smallexample
-(gdb) b some_func
+(@value{GDBP}) b some_func
Breakpoint 2 at 0x1179: some_func. (3 locations)
-(gdb) p $bpnum
+(@value{GDBP}) p $bpnum
$2 = 2
-(gdb)
+(@value{GDBP})
@end smallexample
@vindex $_hit_bpnum@r{, convenience variable}
@@ -4790,11 +4790,11 @@ Set Breaks
@smallexample
Thread 1 "zeoes" hit Breakpoint 2.1, some_func () at zeoes.c:8
8 printf("some func\n");
-(gdb) p $_hit_bpnum
+(@value{GDBP}) p $_hit_bpnum
$5 = 2
-(gdb) p $_hit_locno
+(@value{GDBP}) p $_hit_locno
$6 = 1
-(gdb)
+(@value{GDBP})
@end smallexample
Note that @samp{$_hit_bpnum} and @samp{$bpnum} are not equivalent:
@@ -4807,11 +4807,11 @@ Set Breaks
@smallexample
Breakpoint 1, main (argc=1, argv=0x7fffffffe018) at zeoes.c:24
24 if (argc > 1)
-(gdb) p $_hit_bpnum
+(@value{GDBP}) p $_hit_bpnum
$3 = 1
-(gdb) p $_hit_locno
+(@value{GDBP}) p $_hit_locno
$4 = 1
-(gdb)
+(@value{GDBP})
@end smallexample
The @samp{$_hit_bpnum} and @samp{$_hit_locno} variables can typically be used
@@ -4828,8 +4828,8 @@ Set Breaks
You can also define aliases to easily disable the last hit location or
last hit breakpoint:
@smallexample
-(gdb) alias lld = disable $_hit_bpnum.$_hit_locno
-(gdb) alias lbd = disable $_hit_bpnum
+(@value{GDBP}) alias lld = disable $_hit_bpnum.$_hit_locno
+(@value{GDBP}) alias lbd = disable $_hit_bpnum
@end smallexample
@table @code
@@ -9224,7 +9224,7 @@ Frame Info
6: @}
@end group
@group
-(gdb) info locals
+(@value{GDBP}) info locals
x = 4 <file.c:3>
y = 52
x = 3 <file.c:1, shadowed>
@@ -19886,7 +19886,7 @@ Ravenscar Profile
announced by @value{GDBN} as if they were threads:
@smallexample
-(gdb) continue
+(@value{GDBP}) continue
[New Ravenscar Thread 0x2b8f0]
@end smallexample
@@ -19894,7 +19894,7 @@ Ravenscar Profile
the output of @code{info threads}:
@smallexample
-(gdb) info threads
+(@value{GDBP}) info threads
Id Target Id Frame
1 Thread 1 (CPU#0 [running]) simple () at simple.adb:10
2 Thread 2 (CPU#1 [running]) 0x0000000000003d34 in __gnat_initialize_cpu_devices ()
@@ -27345,7 +27345,7 @@ AArch64
@code{por_el0} when displaying it with the @code{info registers} command.
@smallexample
-(gdb) info registers por_el0
+(@value{GDBP}) info registers por_el0
por_el0 0x0000000000000007 [ P0=rwx ]
@end smallexample
@@ -27356,11 +27356,11 @@ AArch64
@code{por_el0}.
@smallexample
-(gdb) set $por_el0 = 0x7
-(gdb) set $por_p1 = 0x7
-(gdb) info registers por_el0
+(@value{GDBP}) set $por_el0 = 0x7
+(@value{GDBP}) set $por_p1 = 0x7
+(@value{GDBP}) info registers por_el0
por_el0 0x0000000000000077 [ P1=rwx P0=rwx ]
-(gdb) info registers por_p1
+(@value{GDBP}) info registers por_p1
por_p1 0x7 rwx
@end smallexample
@@ -29763,20 +29763,20 @@ Other Misc Settings
new context. For example, the default behavior is below:
@smallexample
-(gdb) inferior 1
+(@value{GDBP}) inferior 1
[Switching to inferior 1 [process 634] (/tmp/test)]
[Switching to thread 1 (process 634)]
#0 main () at test.c:3
3 return 0;
-(gdb)
+(@value{GDBP})
@end smallexample
When the notifications are suppressed, the new context is not printed:
@smallexample
-(gdb) set suppress-cli-notifications on
-(gdb) inferior 1
-(gdb)
+(@value{GDBP}) set suppress-cli-notifications on
+(@value{GDBP}) inferior 1
+(@value{GDBP})
@end smallexample
@item The program being debugged stops:
@@ -29786,25 +29786,25 @@ Other Misc Settings
below is a breakpoint hit:
@smallexample
-(gdb) break test.c:3
+(@value{GDBP}) break test.c:3
Breakpoint 2 at 0x555555555155: file test.c, line 3.
-(gdb) continue
+(@value{GDBP}) continue
Continuing.
Breakpoint 2, main () at test.c:3
3 return 0;
-(gdb)
+(@value{GDBP})
@end smallexample
When the notifications are suppressed, the output becomes:
@smallexample
-(gdb) break test.c:3
+(@value{GDBP}) break test.c:3
Breakpoint 2 at 0x555555555155: file test.c, line 3.
-(gdb) set suppress-cli-notifications on
-(gdb) continue
+(@value{GDBP}) set suppress-cli-notifications on
+(@value{GDBP}) continue
Continuing.
-(gdb)
+(@value{GDBP})
@end smallexample
Suppressing CLI notifications may be useful in scripts to obtain a
@@ -31583,7 +31583,7 @@ TUI Commands
For example:
@example
-(gdb) tui new-layout example src 1 regs 1 status 0 cmd 1
+(@value{GDBP}) tui new-layout example src 1 regs 1 status 0 cmd 1
@end example
Here, the new layout is called @samp{example}. It shows the source
@@ -31594,7 +31594,7 @@ TUI Commands
Here is a more complex example, showing a horizontal layout:
@example
-(gdb) tui new-layout example @{-horizontal src 1 asm 1@} 2 status 0 cmd 1
+(@value{GDBP}) tui new-layout example @{-horizontal src 1 asm 1@} 2 status 0 cmd 1
@end example
This will result in side-by-side source and assembly windows; with the
@@ -32048,7 +32048,7 @@ Context management
@smallexample
-data-evaluate-expression --language c "sizeof (void*)"
^done,value="4"
-(gdb)
+(@value{GDBP})
@end smallexample
The valid language names are the same names accepted by the
@@ -33298,17 +33298,17 @@ GDB/MI Breakpoint Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-break-insert main
^done,bkpt=@{number="1",type="breakpoint",disp="keep",
enabled="y",addr="0x000100d0",func="main",file="hello.c",
fullname="/home/foo/hello.c",line="5",thread-groups=["i1"],
times="0"@}
-(gdb)
+(@value{GDBP})
-break-after 1 3
~
^done
-(gdb)
+(@value{GDBP})
-break-list
^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
@@ -33320,7 +33320,7 @@ GDB/MI Breakpoint Commands
body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
line="5",thread-groups=["i1"],times="0",ignore="3"@}]@}
-(gdb)
+(@value{GDBP})
@end smallexample
@ignore
@@ -33351,16 +33351,16 @@ GDB/MI Breakpoint Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-break-insert main
^done,bkpt=@{number="1",type="breakpoint",disp="keep",
enabled="y",addr="0x000100d0",func="main",file="hello.c",
fullname="/home/foo/hello.c",line="5",thread-groups=["i1"],
times="0"@}
-(gdb)
+(@value{GDBP})
-break-commands 1 "print v" "continue"
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -break-condition
@@ -33387,10 +33387,10 @@ GDB/MI Breakpoint Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-break-condition 1 1
^done
-(gdb)
+(@value{GDBP})
-break-list
^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
@@ -33402,7 +33402,7 @@ GDB/MI Breakpoint Commands
body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
line="5",cond="1",thread-groups=["i1"],times="0",ignore="3"@}]@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -break-delete
@@ -33424,10 +33424,10 @@ GDB/MI Breakpoint Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-break-delete 1
^done
-(gdb)
+(@value{GDBP})
-break-list
^done,BreakpointTable=@{nr_rows="0",nr_cols="6",
hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
@@ -33437,7 +33437,7 @@ GDB/MI Breakpoint Commands
@{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
@{width="40",alignment="2",col_name="what",colhdr="What"@}],
body=[]@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -break-disable
@@ -33459,10 +33459,10 @@ GDB/MI Breakpoint Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-break-disable 2
^done
-(gdb)
+(@value{GDBP})
-break-list
^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
@@ -33474,7 +33474,7 @@ GDB/MI Breakpoint Commands
body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="n",
addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
line="5",thread-groups=["i1"],times="0"@}]@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -break-enable
@@ -33495,10 +33495,10 @@ GDB/MI Breakpoint Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-break-enable 2
^done
-(gdb)
+(@value{GDBP})
-break-list
^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
@@ -33510,7 +33510,7 @@ GDB/MI Breakpoint Commands
body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",
addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
line="5",thread-groups=["i1"],times="0"@}]@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -break-info
@@ -33635,17 +33635,17 @@ GDB/MI Breakpoint Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-break-insert main
^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",
fullname="/home/foo/recursive2.c,line="4",thread-groups=["i1"],
times="0"@}
-(gdb)
+(@value{GDBP})
-break-insert -t foo
^done,bkpt=@{number="2",addr="0x00010774",file="recursive2.c",
fullname="/home/foo/recursive2.c,line="11",thread-groups=["i1"],
times="0"@}
-(gdb)
+(@value{GDBP})
-break-list
^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
@@ -33662,7 +33662,7 @@ GDB/MI Breakpoint Commands
addr="0x00010774",func="foo",file="recursive2.c",
fullname="/home/foo/recursive2.c",line="11",thread-groups=["i1"],
times="0"@}]@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -dprintf-insert
@@ -33727,21 +33727,21 @@ GDB/MI Breakpoint Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
4-dprintf-insert foo "At foo entry\n"
4^done,bkpt=@{number="1",type="dprintf",disp="keep",enabled="y",
addr="0x000000000040061b",func="foo",file="mi-dprintf.c",
fullname="mi-dprintf.c",line="25",thread-groups=["i1"],
times="0",script=["printf \"At foo entry\\n\"","continue"],
original-location="foo"@}
-(gdb)
+(@value{GDBP})
5-dprintf-insert 26 "arg=%d, g=%d\n" arg g
5^done,bkpt=@{number="2",type="dprintf",disp="keep",enabled="y",
addr="0x000000000040062a",func="foo",file="mi-dprintf.c",
fullname="mi-dprintf.c",line="26",thread-groups=["i1"],
times="0",script=["printf \"arg=%d, g=%d\\n\", arg, g","continue"],
original-location="mi-dprintf.c:26"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -break-list
@@ -33786,7 +33786,7 @@ GDB/MI Breakpoint Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-break-list
^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
@@ -33801,13 +33801,13 @@ GDB/MI Breakpoint Commands
bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",
addr="0x00010114",func="foo",file="hello.c",fullname="/home/foo/hello.c",
line="13",thread-groups=["i1"],times="0"@}]@}
-(gdb)
+(@value{GDBP})
@end smallexample
Here's an example of the result when there are no breakpoints:
@smallexample
-(gdb)
+(@value{GDBP})
-break-list
^done,BreakpointTable=@{nr_rows="0",nr_cols="6",
hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
@@ -33817,7 +33817,7 @@ GDB/MI Breakpoint Commands
@{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
@{width="40",alignment="2",col_name="what",colhdr="What"@}],
body=[]@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -break-passcount
@@ -33865,18 +33865,18 @@ GDB/MI Breakpoint Commands
Setting a watchpoint on a variable in the @code{main} function:
@smallexample
-(gdb)
+(@value{GDBP})
-break-watch x
^done,wpt=@{number="2",exp="x"@}
-(gdb)
+(@value{GDBP})
-exec-continue
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="x"@},
value=@{old="-268439212",new="55"@},
frame=@{func="main",args=[],file="recursive2.c",
fullname="/home/foo/bar/recursive2.c",line="5",arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
@end smallexample
Setting a watchpoint on a variable local to a function. @value{GDBN} will stop
@@ -33884,30 +33884,30 @@ GDB/MI Breakpoint Commands
for the watchpoint going out of scope.
@smallexample
-(gdb)
+(@value{GDBP})
-break-watch C
^done,wpt=@{number="5",exp="C"@}
-(gdb)
+(@value{GDBP})
-exec-continue
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="watchpoint-trigger",
wpt=@{number="5",exp="C"@},value=@{old="-276895068",new="3"@},
frame=@{func="callee4",args=[],
file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13",
arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
-exec-continue
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="watchpoint-scope",wpnum="5",
frame=@{func="callee3",args=[@{name="strarg",
value="0x11940 \"A string argument.\""@}],
file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18",
arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
@end smallexample
Listing breakpoints and watchpoints, at different points in the program
@@ -33915,10 +33915,10 @@ GDB/MI Breakpoint Commands
deleted.
@smallexample
-(gdb)
+(@value{GDBP})
-break-watch C
^done,wpt=@{number="2",exp="C"@}
-(gdb)
+(@value{GDBP})
-break-list
^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
@@ -33934,17 +33934,17 @@ GDB/MI Breakpoint Commands
times="1"@},
bkpt=@{number="2",type="watchpoint",disp="keep",
enabled="y",addr="",what="C",thread-groups=["i1"],times="0"@}]@}
-(gdb)
+(@value{GDBP})
-exec-continue
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="C"@},
value=@{old="-276895068",new="3"@},
frame=@{func="callee4",args=[],
file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13",
arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
-break-list
^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
@@ -33960,7 +33960,7 @@ GDB/MI Breakpoint Commands
times="1"@},
bkpt=@{number="2",type="watchpoint",disp="keep",
enabled="y",addr="",what="C",thread-groups=["i1"],times="-5"@}]@}
-(gdb)
+(@value{GDBP})
-exec-continue
^running
^done,reason="watchpoint-scope",wpnum="2",
@@ -33969,7 +33969,7 @@ GDB/MI Breakpoint Commands
file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18",
arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
-break-list
^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
@@ -33983,7 +33983,7 @@ GDB/MI Breakpoint Commands
file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",
thread-groups=["i1"],times="1"@}]@}
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -34029,7 +34029,7 @@ Shared Library GDB/MI Catchpoint Commands
-catch-load -t foo.so
^done,bkpt=@{number="1",type="catchpoint",disp="del",enabled="y",
what="load of library matching foo.so",catch-type="load",times="0"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -34058,7 +34058,7 @@ Shared Library GDB/MI Catchpoint Commands
-catch-unload -d bar.so
^done,bkpt=@{number="2",type="catchpoint",disp="keep",enabled="n",
what="load of library matching bar.so",catch-type="unload",times="0"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@node Ada Exception GDB/MI Catchpoint Commands
@@ -34101,7 +34101,7 @@ Ada Exception GDB/MI Catchpoint Commands
enabled="y",addr="0x0000000000404888",what="failed Ada assertions",
thread-groups=["i1"],times="0",
original-location="__gnat_debug_raise_assert_failure"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -catch-exception
@@ -34150,7 +34150,7 @@ Ada Exception GDB/MI Catchpoint Commands
enabled="y",addr="0x0000000000404874",
what="`Program_Error' Ada exception", thread-groups=["i1"],
times="0",original-location="__gnat_debug_raise_exception"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -catch-handlers
@@ -34194,7 +34194,7 @@ Ada Exception GDB/MI Catchpoint Commands
enabled="y",addr="0x0000000000402f68",
what="`Constraint_Error' Ada exception handlers",thread-groups=["i1"],
times="0",original-location="__gnat_begin_handler"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@node C++ Exception GDB/MI Catchpoint Commands
@@ -34234,10 +34234,10 @@ C++ Exception GDB/MI Catchpoint Commands
what="exception throw",catch-type="throw",
thread-groups=["i1"],
regexp="exception_type",times="0"@}
-(gdb)
+(@value{GDBP})
-exec-run
^running
-(gdb)
+(@value{GDBP})
~"\n"
~"Catchpoint 1 (exception thrown), 0x00007ffff7ae00ed
in __cxa_throw () from /lib64/libstdc++.so.6\n"
@@ -34245,7 +34245,7 @@ C++ Exception GDB/MI Catchpoint Commands
frame=@{addr="0x00007ffff7ae00ed",func="__cxa_throw",
args=[],from="/lib64/libstdc++.so.6",arch="i386:x86-64"@},
thread-id="1",stopped-threads="all",core="6"
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -catch-rethrow
@@ -34278,10 +34278,10 @@ C++ Exception GDB/MI Catchpoint Commands
what="exception rethrow",catch-type="rethrow",
thread-groups=["i1"],
regexp="exception_type",times="0"@}
-(gdb)
+(@value{GDBP})
-exec-run
^running
-(gdb)
+(@value{GDBP})
~"\n"
~"Catchpoint 1 (exception rethrown), 0x00007ffff7ae00ed
in __cxa_rethrow () from /lib64/libstdc++.so.6\n"
@@ -34289,7 +34289,7 @@ C++ Exception GDB/MI Catchpoint Commands
frame=@{addr="0x00007ffff7ae00ed",func="__cxa_rethrow",
args=[],from="/lib64/libstdc++.so.6",arch="i386:x86-64"@},
thread-id="1",stopped-threads="all",core="6"
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -catch-catch
@@ -34322,10 +34322,10 @@ C++ Exception GDB/MI Catchpoint Commands
what="exception catch",catch-type="catch",
thread-groups=["i1"],
regexp="exception_type",times="0"@}
-(gdb)
+(@value{GDBP})
-exec-run
^running
-(gdb)
+(@value{GDBP})
~"\n"
~"Catchpoint 1 (exception caught), 0x00007ffff7ae00ed
in __cxa_begin_catch () from /lib64/libstdc++.so.6\n"
@@ -34333,7 +34333,7 @@ C++ Exception GDB/MI Catchpoint Commands
frame=@{addr="0x00007ffff7ae00ed",func="__cxa_begin_catch",
args=[],from="/lib64/libstdc++.so.6",arch="i386:x86-64"@},
thread-id="1",stopped-threads="all",core="6"
-(gdb)
+(@value{GDBP})
@end smallexample
@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -34360,10 +34360,10 @@ GDB/MI Program Context
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-exec-arguments -v word
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -34407,10 +34407,10 @@ GDB/MI Program Context
@c codespell:ignore-begin
@smallexample
-(gdb)
+(@value{GDBP})
-environment-cd /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@c codespell:ignore-end
@@ -34449,19 +34449,19 @@ GDB/MI Program Context
@c codespell:ignore-begin
@smallexample
-(gdb)
+(@value{GDBP})
-environment-directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd"
-(gdb)
+(@value{GDBP})
-environment-directory ""
^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd"
-(gdb)
+(@value{GDBP})
-environment-directory -r /home/jjohnstn/src/gdb /usr/src
^done,source-path="/home/jjohnstn/src/gdb:/usr/src:$cdir:$cwd"
-(gdb)
+(@value{GDBP})
-environment-directory -r
^done,source-path="$cdir:$cwd"
-(gdb)
+(@value{GDBP})
@end smallexample
@c codespell:ignore-end
@@ -34502,16 +34502,16 @@ GDB/MI Program Context
@c codespell:ignore-begin
@smallexample
-(gdb)
+(@value{GDBP})
-environment-path
^done,path="/usr/bin"
-(gdb)
+(@value{GDBP})
-environment-path /kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb /bin
^done,path="/kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb:/bin:/usr/bin"
-(gdb)
+(@value{GDBP})
-environment-path -r /usr/local/bin
^done,path="/usr/local/bin:/usr/bin"
-(gdb)
+(@value{GDBP})
@end smallexample
@c codespell:ignore-end
@@ -34535,10 +34535,10 @@ GDB/MI Program Context
@c codespell:ignore-begin
@smallexample
-(gdb)
+(@value{GDBP})
-environment-pwd
^done,cwd="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb"
-(gdb)
+(@value{GDBP})
@end smallexample
@c codespell:ignore-end
@@ -34598,7 +34598,7 @@ GDB/MI Thread Commands
file="/tmp/a.c",fullname="/tmp/a.c",line="158",arch="i386:x86_64"@},
state="running"@}],
current-thread-id="1"
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -thread-list-ids
@@ -34624,11 +34624,11 @@ GDB/MI Thread Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-thread-list-ids
^done,thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@},
current-thread-id="1",number-of-threads="3"
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -34655,24 +34655,24 @@ GDB/MI Thread Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-exec-next
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="end-stepping-range",thread-id="2",line="187",
file="../../../devo/gdb/testsuite/gdb.threads/linux-dp.c"
-(gdb)
+(@value{GDBP})
-thread-list-ids
^done,
thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@},
number-of-threads="3"
-(gdb)
+(@value{GDBP})
-thread-select 3
^done,new-thread-id="3",
frame=@{level="0",func="vprintf",
args=[@{name="format",value="0x8048e9c \"%*s%c %d %c\\n\""@},
@{name="arg",value="0x2"@}],file="vprintf.c",line="31",arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -34750,7 +34750,7 @@ GDB/MI Ada Tasking Commands
@{width="1",alignment="2",col_name="name",colhdr="Name"@}],
body=[@{current="*",id="1",task-id=" 644010",thread-id="1",priority="48",
state="Child Termination Wait",name="main_task"@}]@}
-(gdb)
+(@value{GDBP})
@end smallexample
@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -34801,12 +34801,12 @@ GDB/MI Program Execution
@smallexample
-exec-continue
^running
-(gdb)
+(@value{GDBP})
@@Hello world
*stopped,reason="breakpoint-hit",disp="keep",bkptno="2",frame=@{
func="foo",args=[],file="hello.c",fullname="/home/foo/bar/hello.c",
line="13",arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
@end smallexample
For a @samp{breakpoint-hit} stopped reason, when the breakpoint
@@ -34816,12 +34816,12 @@ GDB/MI Program Execution
@smallexample
-exec-continue
^running
-(gdb)
+(@value{GDBP})
@@Hello world
*stopped,reason="breakpoint-hit",disp="keep",bkptno="2",locno="3",frame=@{
func="foo",args=[],file="hello.c",fullname="/home/foo/bar/hello.c",
line="13",arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -exec-finish
@@ -34850,11 +34850,11 @@ GDB/MI Program Execution
@smallexample
-exec-finish
^running
-(gdb)
+(@value{GDBP})
@@hello from foo
*stopped,reason="function-finished",frame=@{func="main",args=[],
file="hello.c",fullname="/home/foo/bar/hello.c",line="7",arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
@end smallexample
Function returning other than @code{void}. The name of the internal
@@ -34864,13 +34864,13 @@ GDB/MI Program Execution
@smallexample
-exec-finish
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="function-finished",frame=@{addr="0x000107b0",func="foo",
args=[@{name="a",value="1"],@{name="b",value="9"@}@},
file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
arch="i386:x86_64"@},
gdb-result-var="$1",return-value="0"
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -34906,23 +34906,23 @@ GDB/MI Program Execution
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
111-exec-continue
111^running
-(gdb)
+(@value{GDBP})
222-exec-interrupt
222^done
-(gdb)
+(@value{GDBP})
111*stopped,signal-name="SIGINT",signal-meaning="Interrupt",
frame=@{addr="0x00010140",func="foo",args=[],file="try.c",
fullname="/home/foo/bar/try.c",line="13",arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
-(gdb)
+(@value{GDBP})
-exec-interrupt
^error,msg="mi_cmd_exec_interrupt: Inferior not executing."
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -exec-jump
@@ -34979,9 +34979,9 @@ GDB/MI Program Execution
@smallexample
-exec-next
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="end-stepping-range",line="8",file="hello.c"
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -35012,14 +35012,14 @@ GDB/MI Program Execution
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-exec-next-instruction
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="end-stepping-range",
addr="0x000100d4",line="5",file="hello.c"
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -35042,23 +35042,23 @@ GDB/MI Program Execution
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
200-break-insert callee4
200^done,bkpt=@{number="1",addr="0x00010734",
file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"@}
-(gdb)
+(@value{GDBP})
000-exec-run
000^running
-(gdb)
+(@value{GDBP})
000*stopped,reason="breakpoint-hit",disp="keep",bkptno="1",
frame=@{func="callee4",args=[],
file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8",
arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
205-break-delete
205^done
-(gdb)
+(@value{GDBP})
111-exec-return
111^done,frame=@{level="0",func="callee3",
args=[@{name="strarg",
@@ -35066,7 +35066,7 @@ GDB/MI Program Execution
file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18",
arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -35102,50 +35102,50 @@ GDB/MI Program Execution
@subsubheading Examples
@smallexample
-(gdb)
+(@value{GDBP})
-break-insert main
^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",line="4"@}
-(gdb)
+(@value{GDBP})
-exec-run
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="breakpoint-hit",disp="keep",bkptno="1",
frame=@{func="main",args=[],file="recursive2.c",
fullname="/home/foo/bar/recursive2.c",line="4",arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@noindent
Program exited normally:
@smallexample
-(gdb)
+(@value{GDBP})
-exec-run
^running
-(gdb)
+(@value{GDBP})
x = 55
*stopped,reason="exited-normally"
-(gdb)
+(@value{GDBP})
@end smallexample
@noindent
Program exited exceptionally:
@smallexample
-(gdb)
+(@value{GDBP})
-exec-run
^running
-(gdb)
+(@value{GDBP})
x = 55
*stopped,reason="exited",exit-code="01"
-(gdb)
+(@value{GDBP})
@end smallexample
Another way the program can terminate is if it receives a signal such as
@code{SIGINT}. In this case, @sc{gdb/mi} displays this:
@smallexample
-(gdb)
+(@value{GDBP})
*stopped,reason="exited-signalled",signal-name="SIGINT",
signal-meaning="Interrupt"
@end smallexample
@@ -35181,12 +35181,12 @@ GDB/MI Program Execution
@smallexample
-exec-step
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="end-stepping-range",
frame=@{func="foo",args=[@{name="a",value="10"@},
@{name="b",value="0"@}],file="recursive2.c",
fullname="/home/foo/bar/recursive2.c",line="11",arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
@end smallexample
Regular stepping:
@@ -35194,9 +35194,9 @@ GDB/MI Program Execution
@smallexample
-exec-step
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="end-stepping-range",line="14",file="recursive2.c"
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -35224,23 +35224,23 @@ GDB/MI Program Execution
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-exec-step-instruction
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="end-stepping-range",
frame=@{func="foo",args=[],file="try.c",
fullname="/home/foo/bar/try.c",line="10",arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
-exec-step-instruction
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="end-stepping-range",
frame=@{addr="0x000100f4",func="foo",args=[],file="try.c",
fullname="/home/foo/bar/try.c",line="10",arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -35265,15 +35265,15 @@ GDB/MI Program Execution
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-exec-until recursive2.c:6
^running
-(gdb)
+(@value{GDBP})
x = 55
*stopped,reason="location-reached",frame=@{func="main",args=[],
file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="6",
arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@ignore
@@ -35321,13 +35321,13 @@ GDB/MI Stack Manipulation
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-stack-info-frame
^done,frame=@{level="1",addr="0x0001076c",func="callee3",
file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17",
arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -stack-info-depth
@@ -35351,22 +35351,22 @@ GDB/MI Stack Manipulation
For a stack with frame levels 0 through 11:
@smallexample
-(gdb)
+(@value{GDBP})
-stack-info-depth
^done,depth="12"
-(gdb)
+(@value{GDBP})
-stack-info-depth 4
^done,depth="4"
-(gdb)
+(@value{GDBP})
-stack-info-depth 12
^done,depth="12"
-(gdb)
+(@value{GDBP})
-stack-info-depth 11
^done,depth="11"
-(gdb)
+(@value{GDBP})
-stack-info-depth 13
^done,depth="12"
-(gdb)
+(@value{GDBP})
@end smallexample
@anchor{-stack-list-arguments}
@@ -35412,7 +35412,7 @@ GDB/MI Stack Manipulation
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-stack-list-frames
^done,
stack=[
@@ -35436,7 +35436,7 @@ GDB/MI Stack Manipulation
file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="32",
arch="i386:x86_64"@}]
-(gdb)
+(@value{GDBP})
-stack-list-arguments 0
^done,
stack-args=[
@@ -35445,7 +35445,7 @@ GDB/MI Stack Manipulation
frame=@{level="2",args=[name="intarg",name="strarg"]@},
frame=@{level="3",args=[name="intarg",name="strarg",name="fltarg"]@},
frame=@{level="4",args=[]@}]
-(gdb)
+(@value{GDBP})
-stack-list-arguments 1
^done,
stack-args=[
@@ -35460,15 +35460,15 @@ GDB/MI Stack Manipulation
@{name="strarg",value="0x11940 \"A string argument.\""@},
@{name="fltarg",value="3.5"@}]@},
frame=@{level="4",args=[]@}]
-(gdb)
+(@value{GDBP})
-stack-list-arguments 0 2 2
^done,stack-args=[frame=@{level="2",args=[name="intarg",name="strarg"]@}]
-(gdb)
+(@value{GDBP})
-stack-list-arguments 1 2 2
^done,stack-args=[frame=@{level="2",
args=[@{name="intarg",value="2"@},
@{name="strarg",value="0x11940 \"A string argument.\""@}]@}]
-(gdb)
+(@value{GDBP})
@end smallexample
@c @subheading -stack-list-exception-handlers
@@ -35526,7 +35526,7 @@ GDB/MI Stack Manipulation
Full stack backtrace:
@smallexample
-(gdb)
+(@value{GDBP})
-stack-list-frames
^done,stack=
[frame=@{level="0",addr="0x0001076c",func="foo",
@@ -35565,13 +35565,13 @@ GDB/MI Stack Manipulation
frame=@{level="11",addr="0x00010738",func="main",
file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="4",
arch="i386:x86_64"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
Show frames between @var{low_frame} and @var{high_frame}:
@smallexample
-(gdb)
+(@value{GDBP})
-stack-list-frames 3 5
^done,stack=
[frame=@{level="3",addr="0x000107a4",func="foo",
@@ -35583,19 +35583,19 @@ GDB/MI Stack Manipulation
frame=@{level="5",addr="0x000107a4",func="foo",
file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
arch="i386:x86_64"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
Show a single frame:
@smallexample
-(gdb)
+(@value{GDBP})
-stack-list-frames 3 3
^done,stack=
[frame=@{level="3",addr="0x000107a4",func="foo",
file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
arch="i386:x86_64"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -35634,17 +35634,17 @@ GDB/MI Stack Manipulation
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-stack-list-locals 0
^done,locals=[name="A",name="B",name="C"]
-(gdb)
+(@value{GDBP})
-stack-list-locals --all-values
^done,locals=[@{name="A",value="1"@},@{name="B",value="2"@},
@{name="C",value="@{1, 2, 3@}"@}]
-stack-list-locals --simple-values
^done,locals=[@{name="A",type="int",value="1"@},
@{name="B",type="int",value="2"@},@{name="C",type="int [3]"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
@anchor{-stack-list-variables}
@@ -35679,7 +35679,7 @@ GDB/MI Stack Manipulation
6: @}
@end group
@group
-(gdb) -stack-list-variables 2
+(@value{GDBP}) -stack-list-variables 2
^done,variables=[@{name="x",type="int",value="4",
filename="name.c",fullname="/home/src/name.c",line="3"@},
@{name="y",type="int",value="5"@},@{name="x",type="int",
@@ -35694,10 +35694,10 @@ GDB/MI Stack Manipulation
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-stack-list-variables --thread 1 --frame 0 --all-values
^done,variables=[@{name="x",value="11"@},@{name="s",value="@{a = 1, b = 2@}"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -35724,10 +35724,10 @@ GDB/MI Stack Manipulation
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-stack-select-frame 2
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -36206,11 +36206,11 @@ GDB/MI Variable Objects
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-var-list-children n
^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp},
numchild=@var{n},type=@var{type}@},@r{(repeats N times)}]
-(gdb)
+(@value{GDBP})
-var-list-children --all-values n
^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp},
numchild=@var{n},value=@var{value},type=@var{type}@},@r{(repeats N times)}]
@@ -36252,7 +36252,7 @@ GDB/MI Variable Objects
@code{A} was created for @code{a}, then we'll get this output:
@smallexample
-(gdb) -var-info-expression A.1
+(@value{GDBP}) -var-info-expression A.1
^done,lang="C",exp="1"
@end smallexample
@@ -36289,7 +36289,7 @@ GDB/MI Variable Objects
@code{C} and a variable object @code{C} was created for variable
@code{c}. Then, we'll get this output:
@smallexample
-(gdb) -var-info-path-expression C.Base.public.m_size
+(@value{GDBP}) -var-info-path-expression C.Base.public.m_size
^done,path_expr=((Base)c).m_size)
@end smallexample
@@ -36352,13 +36352,13 @@ GDB/MI Variable Objects
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-var-assign var1 3
^done,value="3"
-(gdb)
+(@value{GDBP})
-var-update *
^done,changelist=[@{name="var1",in_scope="true",type_changed="false"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -var-update
@@ -36479,14 +36479,14 @@ GDB/MI Variable Objects
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-var-assign var1 3
^done,value="3"
-(gdb)
+(@value{GDBP})
-var-update --all-values var1
^done,changelist=[@{name="var1",value="3",in_scope="true",
type_changed="false"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -var-set-frozen
@@ -36514,10 +36514,10 @@ GDB/MI Variable Objects
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-var-set-frozen V 1
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -var-set-update-range
@@ -36541,7 +36541,7 @@ GDB/MI Variable Objects
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-var-set-update-range V 1 2
^done
@end smallexample
@@ -36583,7 +36583,7 @@ GDB/MI Variable Objects
Resetting the visualizer:
@smallexample
-(gdb)
+(@value{GDBP})
-var-set-visualizer V None
^done
@end smallexample
@@ -36591,7 +36591,7 @@ GDB/MI Variable Objects
Reselecting the default (type-based) visualizer:
@smallexample
-(gdb)
+(@value{GDBP})
-var-set-visualizer V gdb.default_visualizer
^done
@end smallexample
@@ -36600,7 +36600,7 @@ GDB/MI Variable Objects
can be used to instantiate this class for a varobj:
@smallexample
-(gdb)
+(@value{GDBP})
-var-set-visualizer V "lambda val: SomeClass()"
^done
@end smallexample
@@ -36809,7 +36809,7 @@ GDB/MI Data Manipulation
Disassemble from the current value of @code{$pc} to @code{$pc + 20}:
@smallexample
-(gdb)
+(@value{GDBP})
-data-disassemble -s $pc -e "$pc + 20" -- 0
^done,
asm_insns=[
@@ -36823,7 +36823,7 @@ GDB/MI Data Manipulation
inst="sethi %hi(0x11800), %o2"@},
@{address="0x000107d0",func-name="main",offset="20",
inst="or %o2, 0x168, %o4\t! 0x11968 <_lib_version+48>"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
Disassemble the whole @code{main} function. Line 32 is part of
@@ -36841,13 +36841,13 @@ GDB/MI Data Manipulation
[@dots{}]
@{address="0x0001081c",func-name="main",offset="96",inst="ret "@},
@{address="0x00010820",func-name="main",offset="100",inst="restore "@}]
-(gdb)
+(@value{GDBP})
@end smallexample
Disassemble 3 instructions from the start of @code{main}:
@smallexample
-(gdb)
+(@value{GDBP})
-data-disassemble -f basics.c -l 32 -n 3 -- 0
^done,asm_insns=[
@{address="0x000107bc",func-name="main",offset="0",
@@ -36856,13 +36856,13 @@ GDB/MI Data Manipulation
inst="mov 2, %o0"@},
@{address="0x000107c4",func-name="main",offset="8",
inst="sethi %hi(0x11800), %o2"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
Disassemble 3 instructions from the start of @code{main} in mixed mode:
@smallexample
-(gdb)
+(@value{GDBP})
-data-disassemble -f basics.c -l 32 -n 3 -- 1
^done,asm_insns=[
src_and_asm_line=@{line="31",
@@ -36877,7 +36877,7 @@ GDB/MI Data Manipulation
func-name="main",offset="4",inst="mov 2, %o0"@},
@{address="0x000107c4",func-name="main",offset="8",
inst="sethi %hi(0x11800), %o2"@}]@}]
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -36910,16 +36910,16 @@ GDB/MI Data Manipulation
@smallexample
211-data-evaluate-expression A
211^done,value="1"
-(gdb)
+(@value{GDBP})
311-data-evaluate-expression &A
311^done,value="0xefffeb7c"
-(gdb)
+(@value{GDBP})
411-data-evaluate-expression A+3
411^done,value="4"
-(gdb)
+(@value{GDBP})
511-data-evaluate-expression "A + 3"
511^done,value="4"
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -36944,20 +36944,20 @@ GDB/MI Data Manipulation
On a PPC MBX board:
@smallexample
-(gdb)
+(@value{GDBP})
-exec-continue
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="breakpoint-hit",disp="keep",bkptno="1",frame=@{
func="main",args=[],file="try.c",fullname="/home/foo/bar/try.c",
line="5",arch="powerpc"@}
-(gdb)
+(@value{GDBP})
-data-list-changed-registers
^done,changed-registers=["0","1","2","4","5","6","7","8","9",
"10","11","13","14","15","16","17","18","19","20","21","22","23",
"24","25","26","27","28","30","31","64","65","66","67","69"]
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -36987,7 +36987,7 @@ GDB/MI Data Manipulation
For the PPC MBX board:
@smallexample
-(gdb)
+(@value{GDBP})
-data-list-register-names
^done,register-names=["r0","r1","r2","r3","r4","r5","r6","r7",
"r8","r9","r10","r11","r12","r13","r14","r15","r16","r17","r18",
@@ -36996,10 +36996,10 @@ GDB/MI Data Manipulation
"f10","f11","f12","f13","f14","f15","f16","f17","f18","f19","f20",
"f21","f22","f23","f24","f25","f26","f27","f28","f29","f30","f31",
"", "pc","ps","cr","lr","ctr","xer"]
-(gdb)
+(@value{GDBP})
-data-list-register-names 1 2 3
^done,register-names=["r1","r2","r3"]
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -data-list-register-values
@@ -37047,11 +37047,11 @@ GDB/MI Data Manipulation
don't appear in the actual output):
@smallexample
-(gdb)
+(@value{GDBP})
-data-list-register-values r 64 65
^done,register-values=[@{number="64",value="0xfe00a300"@},
@{number="65",value="0x00029002"@}]
-(gdb)
+(@value{GDBP})
-data-list-register-values x
^done,register-values=[@{number="0",value="0xfe0043c8"@},
@{number="1",value="0x3fff88"@},@{number="2",value="0xfffffffe"@},
@@ -37089,7 +37089,7 @@ GDB/MI Data Manipulation
@{number="65",value="0x29002"@},@{number="66",value="0x202f04b5"@},
@{number="67",value="0xfe0043b0"@},@{number="68",value="0xfe00b3e4"@},
@{number="69",value="0x20002b03"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -37164,7 +37164,7 @@ GDB/MI Data Manipulation
word. Display each word in hex.
@smallexample
-(gdb)
+(@value{GDBP})
9-data-read-memory -o -6 -- bytes+6 x 1 3 2
9^done,addr="0x00001390",nr-bytes="6",total-bytes="6",
next-row="0x00001396",prev-row="0x0000138e",next-page="0x00001396",
@@ -37172,20 +37172,20 @@ GDB/MI Data Manipulation
@{addr="0x00001390",data=["0x00","0x01"]@},
@{addr="0x00001392",data=["0x02","0x03"]@},
@{addr="0x00001394",data=["0x04","0x05"]@}]
-(gdb)
+(@value{GDBP})
@end smallexample
Read two bytes of memory starting at address @code{shorts + 64} and
display as a single word formatted in decimal.
@smallexample
-(gdb)
+(@value{GDBP})
5-data-read-memory shorts+64 d 2 1 1
5^done,addr="0x00001510",nr-bytes="2",total-bytes="2",
next-row="0x00001512",prev-row="0x0000150e",
next-page="0x00001512",prev-page="0x0000150e",memory=[
@{addr="0x00001510",data=["128"]@}]
-(gdb)
+(@value{GDBP})
@end smallexample
Read thirty two bytes of memory starting at @code{bytes+16} and format
@@ -37193,7 +37193,7 @@ GDB/MI Data Manipulation
used as the non-printable character.
@smallexample
-(gdb)
+(@value{GDBP})
4-data-read-memory bytes+16 x 1 8 4 x
4^done,addr="0x000013a0",nr-bytes="32",total-bytes="32",
next-row="0x000013c0",prev-row="0x0000139c",
@@ -37206,7 +37206,7 @@ GDB/MI Data Manipulation
@{addr="0x000013b4",data=["0x24","0x25","0x26","0x27"],ascii="$%&'"@},
@{addr="0x000013b8",data=["0x28","0x29","0x2a","0x2b"],ascii="()*+"@},
@{addr="0x000013bc",data=["0x2c","0x2d","0x2e","0x2f"],ascii=",-./"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -data-read-memory-bytes
@@ -37286,12 +37286,12 @@ GDB/MI Data Manipulation
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-data-read-memory-bytes &a 10
^done,memory=[@{begin="0xbffff154",offset="0x00000000",
end="0xbffff15e",
contents="01000000020000000300"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -37333,17 +37333,17 @@ GDB/MI Data Manipulation
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-data-write-memory-bytes &a "aabbccdd"
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@smallexample
-(gdb)
+(@value{GDBP})
-data-write-memory-bytes &a "aabbccdd" 16e
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -37486,7 +37486,7 @@ GDB/MI Tracepoint Commands
An example output would be:
@smallexample
-(gdb)
+(@value{GDBP})
-trace-frame-collected
^done,
explicit-variables=[@{name="myVar",value="1"@}],
@@ -37503,7 +37503,7 @@ GDB/MI Tracepoint Commands
tvars=[@{name="$tvar1",current="43970026"@}],
memory=[@{address="0x0000000000602264",length="4"@},
@{address="0x0000000000615bc0",length="4"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
Where:
@@ -37598,7 +37598,7 @@ GDB/MI Tracepoint Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-trace-list-variables
^done,trace-variables=@{nr_rows="1",nr_cols="3",
hdr=[@{width="15",alignment="-1",col_name="name",colhdr="Name"@},
@@ -37606,7 +37606,7 @@ GDB/MI Tracepoint Commands
@{width="11",alignment="-1",col_name="current",colhdr="Current"@}],
body=[variable=@{name="$trace_timestamp",initial="0"@}
variable=@{name="$foo",initial="10",current="15"@}]@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -trace-save
@@ -37820,7 +37820,7 @@ GDB/MI Symbol Query
@subsubheading Example
@smallexample
@group
-(gdb)
+(@value{GDBP})
-symbol-info-functions
^done,symbols=
@{debug=
@@ -37842,7 +37842,7 @@ GDB/MI Symbol Query
description="static another_float_t f1(int);"@}]@}]@}
@end group
@group
-(gdb)
+(@value{GDBP})
-symbol-info-functions --name f1
^done,symbols=
@{debug=
@@ -37856,7 +37856,7 @@ GDB/MI Symbol Query
description="static another_float_t f1(int);"@}]@}]@}
@end group
@group
-(gdb)
+(@value{GDBP})
-symbol-info-functions --type void
^done,symbols=
@{debug=
@@ -37866,7 +37866,7 @@ GDB/MI Symbol Query
description="void f4(int *);"@}]@}]@}
@end group
@group
-(gdb)
+(@value{GDBP})
-symbol-info-functions --include-nondebug
^done,symbols=
@{debug=
@@ -37925,7 +37925,7 @@ GDB/MI Symbol Query
@smallexample
@group
-(gdb)
+(@value{GDBP})
-symbol-info-module-functions
^done,symbols=
[@{module="mod1",
@@ -37991,7 +37991,7 @@ GDB/MI Symbol Query
@smallexample
@group
-(gdb)
+(@value{GDBP})
-symbol-info-module-variables
^done,symbols=
[@{module="mod1",
@@ -38068,7 +38068,7 @@ GDB/MI Symbol Query
@subsubheading Example
@smallexample
@group
-(gdb)
+(@value{GDBP})
-symbol-info-modules
^done,symbols=
@{debug=
@@ -38083,7 +38083,7 @@ GDB/MI Symbol Query
@{line="26",name="moduse"@}]@}]@}
@end group
@group
-(gdb)
+(@value{GDBP})
-symbol-info-modules --name mod[123]
^done,symbols=
@{debug=
@@ -38132,7 +38132,7 @@ GDB/MI Symbol Query
@subsubheading Example
@smallexample
@group
-(gdb)
+(@value{GDBP})
-symbol-info-types
^done,symbols=
@{debug=
@@ -38149,7 +38149,7 @@ GDB/MI Symbol Query
@{name="int"@}]@}]@}
@end group
@group
-(gdb)
+(@value{GDBP})
-symbol-info-types --name _int_
^done,symbols=
@{debug=
@@ -38201,7 +38201,7 @@ GDB/MI Symbol Query
@subsubheading Example
@smallexample
@group
-(gdb)
+(@value{GDBP})
-symbol-info-variables
^done,symbols=
@{debug=
@@ -38223,7 +38223,7 @@ GDB/MI Symbol Query
description="static int global_i1;"@}]@}]@}
@end group
@group
-(gdb)
+(@value{GDBP})
-symbol-info-variables --name f1
^done,symbols=
@{debug=
@@ -38237,7 +38237,7 @@ GDB/MI Symbol Query
description="static float global_f1;"@}]@}]@}
@end group
@group
-(gdb)
+(@value{GDBP})
-symbol-info-variables --type float
^done,symbols=
@{debug=
@@ -38251,7 +38251,7 @@ GDB/MI Symbol Query
description="static float global_f1;"@}]@}]@}
@end group
@group
-(gdb)
+(@value{GDBP})
-symbol-info-variables --include-nondebug
^done,symbols=
@{debug=
@@ -38359,10 +38359,10 @@ GDB/MI Symbol Query
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-symbol-list-lines basics.c
^done,lines=[@{pc="0x08048554",line="7"@},@{pc="0x0804855a",line="8"@}]
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -38475,10 +38475,10 @@ GDB/MI File Commands
@c codespell:ignore-begin
@smallexample
-(gdb)
+(@value{GDBP})
-file-exec-and-symbols /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@c codespell:ignore-end
@@ -38506,10 +38506,10 @@ GDB/MI File Commands
@c codespell:ignore-begin
@smallexample
-(gdb)
+(@value{GDBP})
-file-exec-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@c codespell:ignore-end
@@ -38558,10 +38558,10 @@ GDB/MI File Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
123-file-list-exec-source-file
123^done,line="1",file="foo.c",fullname="/home/bar/foo.c,macro-info="1"
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -38734,12 +38734,12 @@ GDB/MI File Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-file-list-exec-source-files
^done,shared-libraries=[
@{id="/lib/libfoo.so",target-name="/lib/libfoo.so",host-name="/lib/libfoo.so",symbols-loaded="1",thread-group="i1",ranges=[@{from="0x72815989",to="0x728162c0"@}]@},
@{id="/lib/libbar.so",target-name="/lib/libbar.so",host-name="/lib/libbar.so",symbols-loaded="1",thread-group="i1",ranges=[@{from="0x76ee48c0",to="0x76ee9160"@}]@}]
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -38785,10 +38785,10 @@ GDB/MI File Commands
@c codespell:ignore-begin
@smallexample
-(gdb)
+(@value{GDBP})
-file-symbol-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@c codespell:ignore-end
@@ -38852,12 +38852,12 @@ GDB/MI Target Manipulation
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-target-attach 34
=thread-created,id="1"
*stopped,thread-id="1",frame=@{addr="0xb7f7e410",func="bar",args=[]@}
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@ignore
@@ -38902,10 +38902,10 @@ GDB/MI Target Manipulation
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-target-detach
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -38928,10 +38928,10 @@ GDB/MI Target Manipulation
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-target-disconnect
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -38989,7 +38989,7 @@ GDB/MI Target Manipulation
have been broken down so that they can fit onto a page.
@smallexample
-(gdb)
+(@value{GDBP})
-target-download
+download,@{section=".text",section-size="6668",total-size="9880"@}
+download,@{section=".text",section-sent="512",section-size="6668",
@@ -39035,7 +39035,7 @@ GDB/MI Target Manipulation
total-sent="9796",total-size="9880"@}
^done,address="0x10004",load-size="9880",transfer-rate="6586",
write-rate="429"
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -39135,10 +39135,10 @@ GDB/MI Target Manipulation
addresses and memory region sizes.
@smallexample
-(gdb)
+(@value{GDBP})
-target-flash-erase
^done,erased-regions=@{address="0x0",size="0x40000"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -target-select
@@ -39175,10 +39175,10 @@ GDB/MI Target Manipulation
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-target-select remote /dev/ttya
^connected,addr="0xfe00a300",func="??",args=[]
-(gdb)
+(@value{GDBP})
@end smallexample
@c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -39205,10 +39205,10 @@ GDB/MI File Transfer Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-target-file-put localfile remotefile
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -39231,10 +39231,10 @@ GDB/MI File Transfer Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-target-file-get remotefile localfile
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -39256,10 +39256,10 @@ GDB/MI File Transfer Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-target-file-delete remotefile
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -39395,7 +39395,7 @@ GDB/MI Support Commands
Example output:
@smallexample
-(gdb) -list-features
+(@value{GDBP}) -list-features
^done,features=["feature1","feature2"]
@end smallexample
@@ -39460,7 +39460,7 @@ GDB/MI Support Commands
Example output:
@smallexample
-(gdb) -list-target-features
+(@value{GDBP}) -list-target-features
^done,features=["async"]
@end smallexample
@@ -39502,7 +39502,7 @@ GDB/MI Miscellaneous Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-gdb-exit
^exit
@end smallexample
@@ -39548,10 +39548,10 @@ GDB/MI Miscellaneous Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-gdb-set $foo=3
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -39573,10 +39573,10 @@ GDB/MI Miscellaneous Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-gdb-show annotate
^done,value="0"
-(gdb)
+(@value{GDBP})
@end smallexample
@c @subheading -gdb-source
@@ -39603,7 +39603,7 @@ GDB/MI Miscellaneous Commands
@c This example modifies the actual output from GDB to avoid overfull
@c box in TeX.
@smallexample
-(gdb)
+(@value{GDBP})
-gdb-version
~GNU gdb 5.2.1
~Copyright 2000 Free Software Foundation, Inc.
@@ -39616,7 +39616,7 @@ GDB/MI Miscellaneous Commands
~This GDB was configured as
"--host=sparc-sun-solaris2.5.1 --target=ppc-eabi".
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -list-thread-groups
@@ -39926,13 +39926,13 @@ GDB/MI Miscellaneous Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-interpreter-exec console "break main"
&"During symbol reading, couldn't parse type; debugger out of date?.\n"
&"During symbol reading, bad structure-type format.\n"
~"Breakpoint 1 at 0x8074fc6: file ../../src/gdb/main.c, line 743.\n"
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -inferior-tty-set
@@ -39953,10 +39953,10 @@ GDB/MI Miscellaneous Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-inferior-tty-set /dev/pts/1
^done
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -inferior-tty-show
@@ -39977,13 +39977,13 @@ GDB/MI Miscellaneous Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-inferior-tty-set /dev/pts/1
^done
-(gdb)
+(@value{GDBP})
-inferior-tty-show
^done,inferior_tty_terminal="/dev/pts/1"
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -enable-timings
@@ -40007,28 +40007,28 @@ GDB/MI Miscellaneous Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-enable-timings
^done
-(gdb)
+(@value{GDBP})
-break-insert main
^done,bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
addr="0x080484ed",func="main",file="myprog.c",
fullname="/home/nickrob/myprog.c",line="73",thread-groups=["i1"],
times="0"@},
time=@{wallclock="0.05185",user="0.00800",system="0.00000"@}
-(gdb)
+(@value{GDBP})
-enable-timings no
^done
-(gdb)
+(@value{GDBP})
-exec-run
^running
-(gdb)
+(@value{GDBP})
*stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0",
frame=@{addr="0x080484ed",func="main",args=[@{name="argc",value="1"@},
@{name="argv",value="0xbfb60364"@}],file="myprog.c",
fullname="/home/nickrob/myprog.c",line="73",arch="i386:x86_64"@}
-(gdb)
+(@value{GDBP})
@end smallexample
@findex -complete
@@ -40072,16 +40072,16 @@ GDB/MI Miscellaneous Commands
@subsubheading Example
@smallexample
-(gdb)
+(@value{GDBP})
-complete br
^done,completion="break",
matches=["break","break-range"],
max_completions_reached="0"
-(gdb)
+(@value{GDBP})
-complete "b ma"
^done,completion="b ma",
matches=["b madvise","b main"],max_completions_reached="0"
-(gdb)
+(@value{GDBP})
-complete "b push_b"
^done,completion="b push_back(",
matches=[
@@ -40089,10 +40089,10 @@ GDB/MI Miscellaneous Commands
"b std::string::push_back(char)",
"b std::vector<int, std::allocator<int> >::push_back(int&&)"],
max_completions_reached="0"
-(gdb)
+(@value{GDBP})
-complete "nonexist"
^done,matches=[],max_completions_reached="0"
-(gdb)
+(@value{GDBP})
@end smallexample
@@ -43356,12 +43356,12 @@ Maintenance Commands
Here's an example of using @code{maint ignore-probes}:
@smallexample
-(gdb) maint ignore-probes -verbose libc ^longjmp$
+(@value{GDBP}) maint ignore-probes -verbose libc ^longjmp$
ignore-probes filter has been set to:
PROVIDER: 'libc'
PROBE_NAME: '^longjmp$'
OBJNAME: ''
-(gdb) start
+(@value{GDBP}) start
<... more output ...>
Ignoring SystemTap probe libc longjmp in /lib64/libc.so.6.^M
Ignoring SystemTap probe libc longjmp in /lib64/libc.so.6.^M
diff --git a/gdb/doc/guile.texi b/gdb/doc/guile.texi
index 95f83802f23..7bf773a649e 100644
--- a/gdb/doc/guile.texi
+++ b/gdb/doc/guile.texi
@@ -229,13 +229,13 @@ Basic Guile
Example:
@smallexample
-(gdb) guile (value-type (make-value 1))
+(@value{GDBP}) guile (value-type (make-value 1))
ERROR: Unbound variable: value-type
Error while executing Scheme code.
-(gdb) guile (use-modules (gdb))
-(gdb) guile (value-type (make-value 1))
+(@value{GDBP}) guile (use-modules (gdb))
+(@value{GDBP}) guile (value-type (make-value 1))
int
-(gdb)
+(@value{GDBP})
@end smallexample
The @code{(gdb)} module provides these basic Guile functions.
@@ -565,9 +565,9 @@ Values From Inferior In Guile
@code{make-value} always returns a fresh object.
@smallexample
-(gdb) guile (eq? (make-value 1) (make-value 1))
+(@value{GDBP}) guile (eq? (make-value 1) (make-value 1))
$1 = #f
-(gdb) guile (equal? (make-value 1) (make-value 1))
+(@value{GDBP}) guile (equal? (make-value 1) (make-value 1))
$1 = #t
@end smallexample
@@ -1724,7 +1724,7 @@ Writing a Guile Pretty-Printer
corresponding output of @samp{info pretty-printer}:
@smallexample
-(gdb) info pretty-printer
+(@value{GDBP}) info pretty-printer
my_library.so:
my-library
foo
@@ -1845,14 +1845,14 @@ Commands In Guile
say a bad command argument.
@smallexample
-(gdb) guile (use-modules (gdb))
-(gdb) guile
+(@value{GDBP}) guile (use-modules (gdb))
+(@value{GDBP}) guile
(register-command! (make-command "test-user-error"
#:command-class COMMAND_OBSCURE
#:invoke (lambda (self arg from-tty)
(throw-user-error "Bad argument ~a" arg))))
end
-(gdb) test-user-error ugh
+(@value{GDBP}) test-user-error ugh
ERROR: Bad argument ugh
@end smallexample
@end deffn
@@ -2012,13 +2012,13 @@ Commands In Guile
implemented in Guile:
@smallexample
-(gdb) guile
+(@value{GDBP}) guile
(register-command! (make-command "hello-world"
#:command-class COMMAND_USER
#:doc "Greet the whole world."
#:invoke (lambda (self args from-tty) (display "Hello, World!\n"))))
end
-(gdb) hello-world
+(@value{GDBP}) hello-world
Hello, World!
@end smallexample
@@ -3531,7 +3531,7 @@ Architectures In Guile
Example:
@smallexample
-(gdb) guile (type-name (arch-uchar-type (current-arch)))
+(@value{GDBP}) guile (type-name (arch-uchar-type (current-arch)))
"unsigned char"
@end smallexample
@@ -3559,13 +3559,13 @@ Disassembly In Guile
Example:
@smallexample
-(gdb) guile (use-modules (rnrs io ports))
-(gdb) guile (define pc (value->integer (parse-and-eval "$pc")))
-(gdb) guile (define mem (open-memory #:start pc))
-(gdb) guile (define bv (get-bytevector-n mem 10))
-(gdb) guile (define bv-port (open-bytevector-input-port bv))
-(gdb) guile (define arch (current-arch))
-(gdb) guile (arch-disassemble arch pc #:port bv-port #:offset pc)
+(@value{GDBP}) guile (use-modules (rnrs io ports))
+(@value{GDBP}) guile (define pc (value->integer (parse-and-eval "$pc")))
+(@value{GDBP}) guile (define mem (open-memory #:start pc))
+(@value{GDBP}) guile (define bv (get-bytevector-n mem 10))
+(@value{GDBP}) guile (define bv-port (open-bytevector-input-port bv))
+(@value{GDBP}) guile (define arch (current-arch))
+(@value{GDBP}) guile (arch-disassemble arch pc #:port bv-port #:offset pc)
(((address . 4195516) (asm . "mov $0x4005c8,%edi") (length . 5)))
@end smallexample
@@ -3948,7 +3948,7 @@ Guile Auto-loading
Example:
@smallexample
-(gdb) info auto-load guile-scripts
+(@value{GDBP}) info auto-load guile-scripts
Loaded Script
Yes scm-section-script.scm
full name: /tmp/scm-section-script.scm
@@ -4026,10 +4026,10 @@ Guile Types Module
Then in gdb:
@smallexample
-(gdb) start
-(gdb) guile (use-modules (gdb) (gdb types))
-(gdb) guile (define foo-ref (parse-and-eval "foo_ref"))
-(gdb) guile (get-basic-type (value-type foo-ref))
+(@value{GDBP}) start
+(@value{GDBP}) guile (use-modules (gdb) (gdb types))
+(@value{GDBP}) guile (define foo-ref (parse-and-eval "foo_ref"))
+(@value{GDBP}) guile (get-basic-type (value-type foo-ref))
#<gdb:type int>
@end smallexample
@end deffn
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index ddb347361f7..99d11d35aaf 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -805,7 +805,7 @@ Exception Handling
rather recognizes it when thrown from user Python code. Example:
@smallexample
-(gdb) python
+(@value{GDBP}) python
>class HelloWorld (gdb.Command):
> """Greet the whole world."""
> def __init__ (self):
@@ -817,7 +817,7 @@ Exception Handling
> print ("Hello, World!")
>HelloWorld ()
>end
-(gdb) hello-world 42
+(@value{GDBP}) hello-world 42
hello-world takes no arguments
@end smallexample
@end ftable
@@ -1945,7 +1945,7 @@ Pretty Printing API
reflect any flags that are temporarily in effect.
@smallexample
-(gdb) python print(gdb.print_options ()['max_elements'])
+(@value{GDBP}) python print(gdb.print_options ()['max_elements'])
200
@end smallexample
@end defun
@@ -2171,7 +2171,7 @@ Writing a Pretty-Printer
corresponding output of @samp{info pretty-printer}:
@smallexample
-(gdb) info pretty-printer
+(@value{GDBP}) info pretty-printer
my_library.so:
my_library
foo
@@ -3492,10 +3492,10 @@ Writing an Xmethod
defined above:
@smallexample
-(gdb) p obj.geta()
+(@value{GDBP}) p obj.geta()
$1 = 5
-(gdb) p obj + obj
+(@value{GDBP}) p obj + obj
$2 = 10
@end smallexample
@@ -5635,7 +5635,7 @@ Functions In Python
Now you can use the function in an expression:
@smallexample
-(gdb) print $greet("Bob")
+(@value{GDBP}) print $greet("Bob")
$1 = "Hello, Bob!"
@end smallexample
@@ -9129,7 +9129,7 @@ Python Auto-loading
Example:
@smallexample
-(gdb) info auto-load python-scripts
+(@value{GDBP}) info auto-load python-scripts
Loaded Script
Yes py-section-script.py
full name: /tmp/py-section-script.py
@@ -9215,10 +9215,10 @@ gdb.types
Then in gdb:
@smallexample
-(gdb) start
-(gdb) python import gdb.types
-(gdb) python foo_ref = gdb.parse_and_eval("foo_ref")
-(gdb) python print(gdb.types.get_basic_type(foo_ref.type))
+(@value{GDBP}) start
+(@value{GDBP}) python import gdb.types
+(@value{GDBP}) python foo_ref = gdb.parse_and_eval("foo_ref")
+(@value{GDBP}) python print(gdb.types.get_basic_type(foo_ref.type))
int
@end smallexample
@@ -9391,11 +9391,11 @@ gdb.ptwrite
@exdent @value{GDBN} output after recording the sample program in pt format:
@smallexample
@group
-(gdb) record instruction-history 12,14
+(@value{GDBP}) record instruction-history 12,14
12 0x0040074c <ptwrite64+16>: ptwrite %rbx
13 [0x42]
14 0x00400751 <ptwrite64+21>: mov -0x8(%rbp),%rbx
-(gdb) record function-call-history
+(@value{GDBP}) record function-call-history
1 main
2 ptwrite64
[0x42]
@@ -9432,7 +9432,7 @@ gdb.ptwrite
@smallexample
@group
-(gdb) python-interactive
+(@value{GDBP}) python-interactive
>>> class my_filter():
... def __init__(self):
... self.var = 0
@@ -9452,7 +9452,7 @@ gdb.ptwrite
@end group
@group
-(gdb) record function-call-history 59,64
+(@value{GDBP}) record function-call-history 59,64
59 pthread_create@@GLIBC_2.2.5
60 job()
61 task(void*)
@@ -9464,7 +9464,7 @@ gdb.ptwrite
@end group
@group
-(gdb) info threads
+(@value{GDBP}) info threads
* 1 Thread 0x7ffff7fd8740 (LWP 25796) "ptw_threads" task ()
at bin/ptwrite/ptw_threads.c:45
2 Thread 0x7ffff6eb8700 (LWP 25797) "ptw_threads" task ()
@@ -9472,14 +9472,14 @@ gdb.ptwrite
@end group
@group
-(gdb) thread 2
+(@value{GDBP}) thread 2
[Switching to thread 2 (Thread 0x7ffff6eb8700 (LWP 25797))]
#0 task (arg=0x0) at ptwrite_threads.c:45
45 return NULL;
@end group
@group
-(gdb) record function-call-history 10,14
+(@value{GDBP}) record function-call-history 10,14
10 start_thread
11 task(void*)
12 ptwrite64(unsigned long)
--
2.55.0
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH 2/5] gdb/doc: fix some incorrect '@table @code' uses
2026-10-12 18:54 [PATCH 0/5] gdb/doc: a series of doc clean ups Andrew Burgess
2026-10-12 18:54 ` [PATCH 1/5] gdb/doc: use (@value{GDBP}) for the prompt in examples Andrew Burgess
@ 2026-10-12 18:54 ` Andrew Burgess
2026-10-13 11:56 ` Eli Zaretskii
2026-10-12 18:54 ` [PATCH 3/5] gdb/doc: consistent formatting for on|off on @item lines Andrew Burgess
` (2 subsequent siblings)
4 siblings, 1 reply; 12+ messages in thread
From: Andrew Burgess @ 2026-10-12 18:54 UTC (permalink / raw)
To: gdb-patches; +Cc: Andrew Burgess
When we have something like this:
@table @code
@item blah
This is the text.
@end table
Then the 'blah' text is formatted as '@code{blah}'. We have several
places in the GDB docs where we use '@table @code' when there is a
better alternative than @code.
I also found a few places where we did something like:
@table @code
@item @code{blah}
This is the text.
@end table
In this case the @code around 'blah' is unnecessary, as the table
already applies @code formatting. In this case I've removed the
formatting around the blah text.
I also spotted this pattern:
@table @code
@item @var{blah}, some additional explanation.
This is the text.
@end table
In this case 'blah' is formatted as @var and 'some additional
explanation' is formatted as @code, when I think it is really just
normal text. In this case I change the @code to @asis which will
leave the additional text as-is, i.e. with no special formatting.
I have not tried to check every @table in the docs. This patch mostly
focused on @code to @kbd, though I did fix up a few other tables where
it was obvious that something else should be applied. However, there
are a lot of tables in the docs, my strategy was to basically spend no
more than a second or two looking at a table, if it wasn't immediately
obvious what change was needed then I left the table as @code. My
hope is that this patch improves the quality of the docs.
---
gdb/doc/gdb.texinfo | 622 ++++++++++++++++++++++----------------------
gdb/doc/guile.texi | 6 +-
gdb/doc/python.texi | 16 +-
3 files changed, 322 insertions(+), 322 deletions(-)
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 1f7778a1824..fd298da584c 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -983,7 +983,7 @@ File Options
@c way, both those who look for -foo and --foo in the index, will find
@c it.
-@table @code
+@table @option
@item -symbols @var{file}
@itemx -s @var{file}
@cindex @code{--symbols}
@@ -1098,7 +1098,7 @@ Mode Options
You can run @value{GDBN} in various alternative modes---for example, in
batch mode or quiet mode.
-@table @code
+@table @option
@anchor{-nx}
@item -nx
@itemx -n
@@ -1567,15 +1567,15 @@ Initialization Files
There are two locations that are searched for system wide
initialization files. Both of these locations are always checked:
-@table @code
+@table @file
-@item @file{system.gdbinit}
+@item system.gdbinit
This is a single system-wide initialization file. Its location is
specified with the @code{--with-system-gdbinit} configure option
(@pxref{System-wide configuration}). It is loaded first when
@value{GDBN} starts, before command line options have been processed.
-@item @file{system.gdbinit.d}
+@item system.gdbinit.d
This is the system-wide initialization directory. Its location is
specified with the @code{--with-system-gdbinit-dir} configure option
(@pxref{System-wide configuration}). Files in this directory are
@@ -1655,7 +1655,7 @@ Quitting GDB
@cindex exiting @value{GDBN}
@cindex leaving @value{GDBN}
-@table @code
+@table @kbd
@kindex quit @r{[}@var{expression}@r{]}
@kindex exit @r{[}@var{expression}@r{]}
@kindex q @r{(@code{quit})}
@@ -1687,7 +1687,7 @@ Shell Commands
debugging session, there is no need to leave or suspend @value{GDBN}; you can
just use the @code{shell} command.
-@table @code
+@table @kbd
@kindex shell
@kindex !
@cindex shell escape
@@ -1709,7 +1709,7 @@ Shell Commands
You do not have to use the @code{shell} command for this purpose in
@value{GDBN}:
-@table @code
+@table @kbd
@kindex make
@cindex calling make
@item make @var{make-args}
@@ -1717,7 +1717,7 @@ Shell Commands
arguments. This is equivalent to @samp{shell make @var{make-args}}.
@end table
-@table @code
+@table @kbd
@kindex pipe
@kindex |
@cindex send the output of a gdb command to a shell command
@@ -1787,7 +1787,7 @@ Logging Output
You may want to save the output of @value{GDBN} commands to a file.
There are several commands to control @value{GDBN}'s logging.
-@table @code
+@table @kbd
@kindex set logging enabled
@item set logging enabled [on|off]
Enable or disable logging.
@@ -1923,7 +1923,7 @@ Command Settings
Alternatively, you can use the @code{with} command to change a setting
temporarily, for the duration of a command invocation.
-@table @code
+@table @kbd
@kindex with command
@kindex w @r{(@code{with})}
@cindex settings
@@ -2073,7 +2073,7 @@ Completion
@noindent
This behavior can be controlled with the following commands:
-@table @code
+@table @kbd
@kindex set max-completions
@item set max-completions @var{limit}
@itemx set max-completions unlimited
@@ -2331,7 +2331,7 @@ Help
You can always ask @value{GDBN} itself for information on its commands,
using the command @code{help}.
-@table @code
+@table @kbd
@kindex h @r{(@code{help})}
@item help
@itemx h
@@ -2495,7 +2495,7 @@ Help
Index}.
@c @group
-@table @code
+@table @kbd
@kindex info
@kindex i @r{(@code{info})}
@item info
@@ -2534,7 +2534,7 @@ Help
Here are several miscellaneous @code{show} subcommands, all of which are
exceptional in lacking corresponding @code{set} commands:
-@table @code
+@table @kbd
@kindex show version
@cindex @value{GDBN} version number
@item show version
@@ -2657,7 +2657,7 @@ Starting
@cindex starting
@cindex running
-@table @code
+@table @kbd
@kindex run
@kindex r @r{(@code{run})}
@item run
@@ -2745,7 +2745,7 @@ Starting
table, and reads it again. When it does this, @value{GDBN} tries to retain
your current breakpoints.
-@table @code
+@table @kbd
@kindex start
@item start
@cindex run to main procedure
@@ -2974,7 +2974,7 @@ Arguments
@code{run} with no arguments uses the same arguments used by the previous
@code{run}, or those set by the @code{set args} command.
-@table @code
+@table @kbd
@kindex set args
@item set args
Specify the arguments to be used the next time your program is run. If
@@ -3026,7 +3026,7 @@ Environment
debugging, it can be useful to try running your program with a modified
environment without having to start @value{GDBN} over again.
-@table @code
+@table @kbd
@kindex path
@item path @var{directory}
Add @var{directory} to the front of the @env{PATH} environment variable
@@ -3128,7 +3128,7 @@ Working Directory
inherit the remote server's current working directory if remote
debugging.
-@table @code
+@table @kbd
@kindex set cwd
@cindex change inferior's working directory
@anchor{set cwd command}
@@ -3191,7 +3191,7 @@ Input/Output
modes your program was using and switches back to them when you continue
running your program.
-@table @code
+@table @kbd
@kindex info terminal
@item info terminal
Displays information recorded by @value{GDBN} about the terminal modes your
@@ -3240,7 +3240,7 @@ Input/Output
display the name of the terminal that will be used for future runs of your
program.
-@table @code
+@table @kbd
@item set inferior-tty [ @var{tty} ]
@kindex set inferior-tty
Set the tty for the program being debugged to @var{tty}. Omitting @var{tty}
@@ -3257,7 +3257,7 @@ Attach
@kindex attach
@cindex attach
-@table @code
+@table @kbd
@item attach @var{process-id}
This command attaches to a running process---one that was started
outside @value{GDBN}. (@code{info files} shows your active
@@ -3288,7 +3288,7 @@ Attach
handle the mismatch. @value{GDBN} tries to compare the files by
comparing their build IDs (@pxref{build ID}), if available.
-@table @code
+@table @kbd
@kindex exec-file-mismatch
@cindex set exec-file-mismatch
@item set exec-file-mismatch @samp{ask|warn|off}
@@ -3315,7 +3315,7 @@ Attach
process continue running, you may use the @code{continue} command after
attaching @value{GDBN} to the process.
-@table @code
+@table @kbd
@kindex detach
@item detach
When you have finished debugging the attached process, you can use the
@@ -3337,7 +3337,7 @@ Attach
@node Kill Process
@section Killing the Child Process
-@table @code
+@table @kbd
@kindex kill
@item kill
Kill the child process in which your program is running under @value{GDBN}.
@@ -3396,7 +3396,7 @@ Inferiors Connections and Programs
inferiors}}:
@anchor{info inferiors command}
-@table @code
+@table @kbd
@kindex info inferiors [ @var{id}@dots{} ]
@item info inferiors
Print a list of all inferiors currently being managed by @value{GDBN}.
@@ -3455,7 +3455,7 @@ Inferiors Connections and Programs
To get information about the current inferior, use @code{inferior}:
-@table @code
+@table @kbd
@kindex inferior
@item inferior
Shows information about the current inferior.
@@ -3472,7 +3472,7 @@ Inferiors Connections and Programs
To find out what open target connections exist at any moment, use
@w{@code{info connections}}:
-@table @code
+@table @kbd
@kindex info connections [ @var{id}@dots{} ]
@item info connections
Print a list of all open target connections currently being managed by
@@ -3512,7 +3512,7 @@ Inferiors Connections and Programs
To switch focus between inferiors, use the @code{inferior} command:
-@table @code
+@table @kbd
@kindex inferior @var{infno}
@item inferior @var{infno}
Make inferior number @var{infno} the current inferior. The argument
@@ -3534,7 +3534,7 @@ Inferiors Connections and Programs
remove inferiors from the debugging session use the
@w{@code{remove-inferiors}} command.
-@table @code
+@table @kbd
@anchor{add_inferior_cli}
@kindex add-inferior
@item add-inferior [ -copies @var{n} ] [ -exec @var{executable} ] [-no-connection ]
@@ -3632,7 +3632,7 @@ Inferiors Connections and Programs
inferior}} command (allowing it to run independently), or kill it
using the @w{@code{kill inferiors}} command:
-@table @code
+@table @kbd
@kindex detach inferiors @var{infno}@dots{}
@item detach inferior @var{infno}@dots{}
Detach from the inferior or inferiors identified by @value{GDBN}
@@ -3657,7 +3657,7 @@ Inferiors Connections and Programs
To be notified when inferiors are started or exit under @value{GDBN}'s
control use @w{@code{set print inferior-events}}:
-@table @code
+@table @kbd
@kindex set print inferior-events
@cindex print messages on inferior start and exit
@item set print inferior-events
@@ -3684,7 +3684,7 @@ Inferiors Connections and Programs
spaces in a debug session. You can do that with the @w{@code{maint
info program-spaces}} command.
-@table @code
+@table @kbd
@kindex maint info program-spaces
@item maint info program-spaces
Print a list of all program spaces currently being managed by
@@ -3745,7 +3745,7 @@ Inferior-Specific Breakpoints
When debugging multiple inferiors, you can choose whether to set
breakpoints for all inferiors, or for a particular inferior.
-@table @code
+@table @kbd
@cindex breakpoints and inferiors
@cindex inferior-specific breakpoints
@kindex break @dots{} inferior @var{inferior-id}
@@ -3953,7 +3953,7 @@ Threads
Thread 1 "main" received signal SIGINT, Interrupt.
@end smallexample
-@table @code
+@table @kbd
@anchor{info_threads}
@kindex info threads
@item info threads @r{[}-gid@r{]} @r{[}-stopped@r{]} @r{[}-running@r{]} @r{[}@var{thread-id-list}@r{]}
@@ -4029,14 +4029,14 @@ Threads
On Solaris, you can display more information about user threads with a
Solaris-specific command:
-@table @code
+@table @kbd
@item maint info sol-threads
@kindex maint info sol-threads
@cindex thread info (Solaris)
Display info on Solaris user threads.
@end table
-@table @code
+@table @kbd
@kindex thread @var{thread-id}
@item thread @var{thread-id}
Make thread ID @var{thread-id} the current thread. The command
@@ -4187,7 +4187,7 @@ Threads
watchpoints in programs with multiple threads.
@anchor{set libthread-db-search-path}
-@table @code
+@table @kbd
@kindex set libthread-db-search-path
@cindex search path for @code{libthread_db}
@item set libthread-db-search-path @r{[}@var{path}@r{]}
@@ -4275,7 +4275,7 @@ Threads
versions earlier than 2.34, but not with @code{libpthread}, and use of
other (non-@acronym{GLIBC}) C libraries.
-@table @code
+@table @kbd
@kindex maint set force-internal-tls-address-lookup
@kindex maint show force-internal-tls-address-lookup
@cindex internal @acronym{TLS} address lookup
@@ -4337,7 +4337,7 @@ Forks
If you want to follow the child process instead of the parent process,
use the command @w{@code{set follow-fork-mode}}.
-@table @code
+@table @kbd
@kindex set follow-fork-mode
@item set follow-fork-mode @var{mode}
Set the debugger response to a program call of @code{fork} or
@@ -4364,7 +4364,7 @@ Forks
On Linux, if you want to debug both the parent and child processes, use the
command @w{@code{set detach-on-fork}}.
-@table @code
+@table @kbd
@kindex set detach-on-fork
@item set detach-on-fork @var{mode}
Tells gdb whether to detach one of the processes after a fork, or
@@ -4419,7 +4419,7 @@ Forks
You can change this behavior with the @w{@code{set follow-exec-mode}}
command.
-@table @code
+@table @kbd
@kindex set follow-exec-mode
@item set follow-exec-mode @var{mode}
@@ -4514,7 +4514,7 @@ Checkpoint/Restart
To use the @code{checkpoint}/@code{restart} method of debugging:
-@table @code
+@table @kbd
@kindex checkpoint
@item checkpoint
Save a snapshot of the debugged program's current execution state.
@@ -4629,7 +4629,7 @@ Stopping
ample explanation of the status of your program---but you can also
explicitly request this information at any time.
-@table @code
+@table @kbd
@kindex info program
@item info program
Display information about the status of your program: whether it is
@@ -4832,7 +4832,7 @@ Set Breaks
(@value{GDBP}) alias lbd = disable $_hit_bpnum
@end smallexample
-@table @code
+@table @kbd
@item break @var{locspec}
Set a breakpoint at all the code locations in your program that result
from resolving the given @var{locspec}. @var{locspec} can specify a
@@ -5195,7 +5195,7 @@ Set Breaks
@kindex set breakpoint pending
@kindex show breakpoint pending
-@table @code
+@table @kbd
@item set breakpoint pending auto
This is the default behavior. When @value{GDBN} cannot resolve the
location spec, it queries you whether a pending breakpoint should be
@@ -5232,7 +5232,7 @@ Set Breaks
@kindex set breakpoint auto-hw
@kindex show breakpoint auto-hw
-@table @code
+@table @kbd
@item set breakpoint auto-hw on
This is the default behavior. When @value{GDBN} sets a breakpoint, it
will try to use the target memory map to decide if software or hardware
@@ -5256,7 +5256,7 @@ Set Breaks
@kindex set breakpoint always-inserted
@kindex show breakpoint always-inserted
-@table @code
+@table @kbd
@item set breakpoint always-inserted off
All breakpoints, including newly added by the user, are inserted in
the target only when the target is resumed. All breakpoints are
@@ -5280,7 +5280,7 @@ Set Breaks
@kindex set breakpoint condition-evaluation
@kindex show breakpoint condition-evaluation
-@table @code
+@table @kbd
@item set breakpoint condition-evaluation host
This option commands @value{GDBN} to evaluate the breakpoint
conditions on the host's side. Unconditional breakpoints are sent to
@@ -5368,7 +5368,7 @@ Set Watchpoints
@value{GDBN} includes support for hardware watchpoints, which do not
slow down the running of your program.
-@table @code
+@table @kbd
@kindex watch
@item watch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{thread-id}@r{]} @r{[}mask @var{maskvalue}@r{]} @r{[}task @var{task-id}@r{]}
Set a watchpoint for an expression. @value{GDBN} will break when the
@@ -5460,7 +5460,7 @@ Set Watchpoints
@code{can-use-hw-watchpoints} to zero will still use the hardware
mechanism of watching expression values.)
-@table @code
+@table @kbd
@item set can-use-hw-watchpoints
@kindex set can-use-hw-watchpoints
Set whether or not to use hardware watchpoints.
@@ -5566,12 +5566,12 @@ Set Catchpoints
kinds of program events, such as C@t{++} exceptions or the loading of a
shared library. Use the @code{catch} command to set a catchpoint.
-@table @code
+@table @kbd
@kindex catch
@item catch @var{event}
Stop when @var{event} occurs. The @var{event} can be any of the following:
-@table @code
+@table @kbd
@item throw @r{[}@var{regexp}@r{]}
@itemx rethrow @r{[}@var{regexp}@r{]}
@itemx catch @r{[}@var{regexp}@r{]}
@@ -5928,7 +5928,7 @@ Delete Breaks
automatically ignores breakpoints on the first instruction to be executed
when you continue execution without changing the execution address.
-@table @code
+@table @kbd
@kindex clear
@item clear
Delete any breakpoints at the next instruction to be executed in the
@@ -5942,7 +5942,7 @@ Delete Breaks
of @var{locspec}. Which code locations correspond to @var{locspec}
depends on the form used in the location specification @var{locspec}:
-@table @code
+@table @asis
@item @var{linenum}
@itemx @var{filename}:@var{linenum}
@itemx -line @var{linenum}
@@ -6020,7 +6020,7 @@ Disabling
You can use the following commands to enable or disable breakpoints,
watchpoints, tracepoints, and catchpoints:
-@table @code
+@table @kbd
@kindex disable
@kindex dis @r{(@code{disable})}
@item disable @r{[}breakpoints@r{]} @r{[}@var{list}@dots{}@r{]}
@@ -6124,7 +6124,7 @@ Conditions
@code{condition} is the only way to impose a further condition on a
catchpoint.
-@table @code
+@table @kbd
@kindex condition
@item condition @var{bnum} @var{expression}
Specify @var{expression} as the break condition for breakpoint,
@@ -6170,7 +6170,7 @@ Conditions
value is @var{n}, the breakpoint does not stop the next @var{n} times
your program reaches it.
-@table @code
+@table @kbd
@kindex ignore
@item ignore @var{bnum} @var{count}
Set the ignore count of breakpoint number @var{bnum} to @var{count}.
@@ -6208,7 +6208,7 @@ Break Commands
example, you might want to print the values of certain expressions, or
enable other breakpoints.
-@table @code
+@table @kbd
@kindex commands
@kindex end@r{ (breakpoint commands)}
@item commands @r{[}@var{list}@dots{}@r{]}
@@ -6318,7 +6318,7 @@ Dynamic Printf
target. Using the stub/agent is also more efficient, as it can do
everything without needing to communicate with @value{GDBN}.
-@table @code
+@table @kbd
@kindex dprintf
@item dprintf @var{locspec},@var{template},@var{expression}[,@var{expression}@dots{}]
Whenever execution reaches a code location that results from resolving
@@ -6421,7 +6421,7 @@ Save Breakpoints
To save breakpoint definitions to a file use the @w{@code{save
breakpoints}} command.
-@table @code
+@table @kbd
@kindex save breakpoints
@cindex save breakpoints to a file for future sessions
@item save breakpoints [@var{filename}]
@@ -6481,7 +6481,7 @@ Static Probe Points
You can examine the available static static probes using @code{info
probes}, with optional arguments:
-@table @code
+@table @kbd
@kindex info probes
@item info probes @r{[}@var{type}@r{]} @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
If given, @var{type} is either @code{stap} for listing
@@ -6514,7 +6514,7 @@ Static Probe Points
commands, with optional arguments:
@anchor{enable probes}
-@table @code
+@table @kbd
@kindex enable probes
@item enable probes @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
If given, @var{provider} is a regular expression used to match against
@@ -6645,7 +6645,7 @@ Continuing and Stepping
or you may step into the signal's handler (@pxref{stepping and signal
handlers}).)
-@table @code
+@table @kbd
@kindex continue
@kindex c @r{(@code{continue})}
@kindex fg @r{(resume foreground execution)}
@@ -6680,7 +6680,7 @@ Continuing and Stepping
and then step through the suspect area, examining the variables that are
interesting, until you see the problem happen.
-@table @code
+@table @kbd
@kindex step
@kindex s @r{(@code{step})}
@item step
@@ -6911,7 +6911,7 @@ Continuing and Stepping
enabled. You can use the following command to turn off range stepping
if necessary:
-@table @code
+@table @kbd
@kindex set range-stepping
@kindex show range-stepping
@item set range-stepping
@@ -6972,14 +6972,14 @@ Skipping Over Functions and Files
See for example @samp{man 7 glob} on @sc{gnu}/Linux systems for a
description of @code{glob}-style patterns.
-@table @code
+@table @kbd
@kindex skip
@item skip @r{[}@var{options}@r{]}
The basic form of the @code{skip} command takes zero or more options
that specify what to skip.
The @var{options} argument is any useful combination of the following:
-@table @code
+@table @kbd
@item -file @var{file}
Functions in @var{file} will be skipped over when stepping.
@@ -7090,7 +7090,7 @@ Skipping Over Functions and Files
Skips can be listed, deleted, disabled, and enabled, much like breakpoints.
These are the commands for managing your list of skips:
-@table @code
+@table @kbd
@kindex info skip
@item info skip @r{[}@var{range}@r{]}
Print details about the specified skip(s). If @var{range} is not specified,
@@ -7214,7 +7214,7 @@ Signals
but to stop your program immediately whenever an error signal happens.
You can change these settings with the @code{handle} command.
-@table @code
+@table @kbd
@kindex info signals
@kindex info handle
@item info signals
@@ -7478,7 +7478,7 @@ All-Stop Mode
On some OSes, you can modify @value{GDBN}'s default behavior by
locking the OS scheduler to allow only a single thread to run.
-@table @code
+@table @kbd
@item set scheduler-locking @var{mode}
@cindex scheduler-locking
@cindex scheduler locking mode
@@ -7533,7 +7533,7 @@ All-Stop Mode
you can instruct @value{GDBN} to allow all threads of all the
inferiors to run with the @w{@code{set schedule-multiple}} command.
-@table @code
+@table @kbd
@kindex set schedule-multiple
@item set schedule-multiple
Set the mode for allowing threads of multiple processes to be resumed
@@ -7580,7 +7580,7 @@ Non-Stop Mode
You can use these commands to manipulate the non-stop mode setting:
-@table @code
+@table @kbd
@kindex set non-stop
@item set non-stop on
Enable non-stop mode.
@@ -7648,7 +7648,7 @@ Background Execution
just @code{c&}. The execution commands that accept background execution
are:
-@table @code
+@table @kbd
@kindex run&
@item run
@xref{Starting, , Starting your Program}.
@@ -7697,7 +7697,7 @@ Background Execution
You can interrupt your program while it is running in the background by
using the @code{interrupt} command.
-@table @code
+@table @kbd
@kindex interrupt
@item interrupt
@itemx interrupt -a
@@ -7715,7 +7715,7 @@ Thread-Specific Breakpoints
Programs with Multiple Threads}), you can choose whether to set
breakpoints on all threads, or on a particular thread.
-@table @code
+@table @kbd
@cindex breakpoints and threads
@cindex thread breakpoints
@kindex break @dots{} thread @var{thread-id}
@@ -7832,7 +7832,7 @@ Observer Mode
then breakpoints that work by writing trap instructions into the code
stream will still not be able to be placed.
-@table @code
+@table @kbd
@kindex observer
@item set observer on
@@ -7958,7 +7958,7 @@ Reverse Execution
If you are debugging in a target environment that supports
reverse execution, @value{GDBN} provides the following commands.
-@table @code
+@table @kbd
@kindex reverse-continue
@kindex rc @r{(@code{reverse-continue})}
@item reverse-continue @r{[}@var{ignore-count}@r{]}
@@ -8086,7 +8086,7 @@ Process Record and Replay
For architecture environments that support process record and replay,
@value{GDBN} provides the following commands:
-@table @code
+@table @kbd
@kindex target record
@kindex target record-full
@kindex target record-btrace
@@ -8201,7 +8201,7 @@ Process Record and Replay
Go to a specific location in the execution log. There are several
ways to specify the location to go to:
-@table @code
+@table @kbd
@item record goto begin
@itemx record goto start
Go to the beginning of the execution log.
@@ -8517,7 +8517,7 @@ Process Record and Replay
There are several ways to specify what part of the execution log to
disassemble:
-@table @code
+@table @kbd
@item record instruction-history @var{insn}
Disassembles ten instructions starting from instruction number
@var{insn}.
@@ -8591,7 +8591,7 @@ Process Record and Replay
printed in execution order. There are several ways to specify what
to print:
-@table @code
+@table @kbd
@item record function-call-history @var{func}
Prints ten functions starting from function number @var{func}.
@@ -8743,7 +8743,7 @@ Backtrace
printed. You can stop the backtrace at any time by typing the system
interrupt character, normally @kbd{Ctrl-c}.
-@table @code
+@table @kbd
@item backtrace [@var{option}]@dots{} [@var{qualifier}]@dots{} [@var{count}]
@itemx bt [@var{option}]@dots{} [@var{qualifier}]@dots{} [@var{count}]
Print the backtrace of the entire stack.
@@ -8923,7 +8923,7 @@ Backtrace
If you need to examine the startup code, or limit the number of levels
in a backtrace, you can change this behavior:
-@table @code
+@table @kbd
@item set backtrace past-main
@itemx set backtrace past-main on
@anchor{set backtrace past-main}
@@ -8966,7 +8966,7 @@ Backtrace
You can control how file names are displayed.
-@table @code
+@table @kbd
@item set filename-display
@itemx set filename-display relative
@cindex filename-display
@@ -8990,7 +8990,7 @@ Selection
selecting a stack frame; all of them finish by printing a brief description
of the stack frame just selected.
-@table @code
+@table @kbd
@kindex frame@r{, selecting}
@kindex f @r{(@code{frame})}
@item frame @r{[} @var{frame-selection-spec} @r{]}
@@ -9102,7 +9102,7 @@ Selection
@xref{List, ,Printing Source Lines},
for details.
-@table @code
+@table @kbd
@kindex select-frame
@item select-frame @r{[} @var{frame-selection-spec} @r{]}
The @code{select-frame} command is a variant of @code{frame} that does
@@ -9129,7 +9129,7 @@ Frame Info
There are several other commands to print information about the selected
stack frame.
-@table @code
+@table @kbd
@item frame
@itemx f
When used without any argument, this command does not change which
@@ -9282,7 +9282,7 @@ Frame Apply
@section Applying a Command to Several Frames.
@kindex frame apply
@cindex apply command to several frames
-@table @code
+@table @kbd
@item frame apply [all | @var{count} | @var{-count} | level @var{level}@dots{}] [@var{option}]@dots{} @var{command}
The @code{frame apply} command allows you to apply the named
@var{command} to one or more frames.
@@ -9395,7 +9395,7 @@ Frame Apply
@end table
-@table @code
+@table @kbd
@kindex faas
@cindex apply a command to all frames (ignoring errors and empty output)
@@ -9428,7 +9428,7 @@ Frame Filter Management
Managing frame filters is performed by several commands available
within @value{GDBN}, detailed here.
-@table @code
+@table @kbd
@kindex info frame-filter
@item info frame-filter
Print a list of installed frame filters from all dictionaries, showing
@@ -9598,7 +9598,7 @@ List
Here are the forms of the @code{list} command most commonly used:
-@table @code
+@table @kbd
@item list @var{linenum}
Print lines centered around line number @var{linenum} in the
current source file.
@@ -9632,7 +9632,7 @@ List
By default, @value{GDBN} prints ten source lines with any of these forms of
the @code{list} command. You can change this using @code{set listsize}:
-@table @code
+@table @kbd
@kindex set listsize
@item set listsize @var{count}
@itemx set listsize unlimited
@@ -9659,7 +9659,7 @@ List
Here is a complete description of the possible arguments for @code{list}:
-@table @code
+@table @kbd
@item list @var{locspec}
Print lines centered around the line or lines of all the code
locations that result from resolving @var{locspec}.
@@ -9983,7 +9983,7 @@ Address Locations
that frequently occur during debugging. Here are the various forms
of @var{address}:
-@table @code
+@table @asis
@item @var{expression}
Any expression valid in the current working language.
@@ -10019,7 +10019,7 @@ Edit
Alternatively, there are several ways to specify what part of the file you
want to print if you want to see other parts of the program:
-@table @code
+@table @kbd
@item edit @var{locspec}
Edit the source file of the code location that results from resolving
@code{locspec}. Editing starts at the source file and source line
@@ -10033,7 +10033,7 @@ Edit
Here are the forms of the @code{edit} command most commonly used:
-@table @code
+@table @kbd
@item edit @var{number}
Edit the current source file with @var{number} as the active line number.
@@ -10075,7 +10075,7 @@ Search
There are two commands for searching through the current source file for a
regular expression.
-@table @code
+@table @kbd
@kindex search
@kindex forward-search
@c codespell:ignore-begin
@@ -10305,7 +10305,7 @@ Source Path
with debug information and corresponding source code are being moved
together.
-@table @code
+@table @kbd
@item directory @var{dirname} @dots{}
@item dir @var{dirname} @dots{}
Add directory @var{dirname} to the front of the source path. Several
@@ -10420,7 +10420,7 @@ Machine Code
line specified. Also, @code{info line} prints addresses in symbolic form as
well as hex.
-@table @code
+@table @kbd
@kindex info line
@item info line
@itemx info line @var{locspec}
@@ -10479,7 +10479,7 @@ Machine Code
line.
@anchor{disassemble}
-@table @code
+@table @kbd
@kindex disassemble
@cindex assembly instructions
@cindex instructions, assembly
@@ -10719,7 +10719,7 @@ Machine Code
location of the relocation table. On some architectures, @value{GDBN}
might be able to resolve these to actual function names.
-@table @code
+@table @kbd
@kindex set disassembler-options
@cindex disassembler options
@item set disassembler-options @var{option1}[,@var{option2}@dots{}]
@@ -10740,7 +10740,7 @@ Machine Code
Show the current setting of the disassembler options.
@end table
-@table @code
+@table @kbd
@kindex set disassembly-flavor
@cindex Intel disassembly flavor
@cindex AT&T disassembly flavor
@@ -10758,7 +10758,7 @@ Machine Code
Show the current setting of the disassembly flavor.
@end table
-@table @code
+@table @kbd
@kindex set disassemble-next-line
@kindex show disassemble-next-line
@item set disassemble-next-line
@@ -10792,7 +10792,7 @@ Disable Reading Source
The following command can be used to control whether @value{GDBN}
should access source code files or not:
-@table @code
+@table @kbd
@kindex set source open
@kindex show source open
@item set source open @r{[}on@r{|}off@r{]}
@@ -10820,7 +10820,7 @@ Data
Different Languages}). It may also print the expression using a
Python-based pretty-printer (@pxref{Pretty Printing}).
-@table @code
+@table @kbd
@item print [[@var{options}] --] @var{expr}
@itemx print [[@var{options}] --] /@var{f} @var{expr}
@var{expr} is an expression (in the source language). By default the
@@ -10976,7 +10976,7 @@ Data
itself) and explore all the way down to leaf scalar values/fields
embedded in the higher level data types.
-@table @code
+@table @kbd
@item explore @var{arg}
@var{arg} is either an expression (in the source language), or a type
visible in the current context of the program being debugged.
@@ -11091,7 +11091,7 @@ Data
being invoked, while the latter is a way to explicitly specify that type
exploration of the argument is being invoked.
-@table @code
+@table @kbd
@item explore value @var{expr}
@cindex explore value
This sub-command of @code{explore} explores the value of the
@@ -11256,7 +11256,7 @@ Ambiguous Expressions
@end group
@end smallexample
-@table @code
+@table @kbd
@kindex set multiple-symbols
@item set multiple-symbols @var{mode}
@cindex multiple-symbols menu
@@ -11880,7 +11880,7 @@ Memory
whether the program has corrupted its own read-only sections. The
@code{compare-sections} command is provided for such situations.
-@table @code
+@table @kbd
@kindex compare-sections
@item compare-sections @r{[}@var{section-name}@r{|}@code{-r}@r{]}
Compare the data of a loadable section @var{section-name} in the
@@ -11926,7 +11926,7 @@ Memory Tagging
The @code{memory-tag} commands are the following:
-@table @code
+@table @kbd
@kindex memory-tag print-logical-tag
@item memory-tag print-logical-tag @var{pointer_expression}
Print the logical tag stored in @var{pointer_expression}.
@@ -11980,7 +11980,7 @@ Auto Display
specification---it uses @code{x} if you specify either the @samp{i}
or @samp{s} format, or a unit size; otherwise it uses @code{print}.
-@table @code
+@table @kbd
@kindex display
@item display @var{expr}
Add the expression @var{expr} to the list of expressions to display
@@ -12005,7 +12005,7 @@ Auto Display
instruction about to be executed each time execution stops (@samp{$pc}
is a common name for the program counter; @pxref{Registers, ,Registers}).
-@table @code
+@table @kbd
@kindex delete display
@kindex undisplay
@item undisplay @var{dnums}@dots{}
@@ -12074,7 +12074,7 @@ Print Settings
@noindent
These settings are useful for debugging programs in any language:
-@table @code
+@table @kbd
@kindex set print
@anchor{set print address}
@item set print address
@@ -12126,7 +12126,7 @@ Print Settings
you can set @value{GDBN} to print the source file and line number when
it prints a symbolic address:
-@table @code
+@table @kbd
@item set print symbol-filename on
@cindex source file and line of a symbol
@cindex symbol, source file and line
@@ -12149,7 +12149,7 @@ Print Settings
Also, you may wish to see the symbolic form only if the address being
printed is reasonably close to the closest earlier symbol:
-@table @code
+@table @kbd
@item set print max-symbolic-offset @var{max-offset}
@itemx set print max-symbolic-offset unlimited
@cindex maximum value for offset of closest symbol
@@ -12189,7 +12189,7 @@ Print Settings
@samp{set print symbol on}:
@anchor{set print symbol}
-@table @code
+@table @kbd
@item set print symbol on
Tell @value{GDBN} to print the symbol corresponding to an address, if
one exists.
@@ -12206,7 +12206,7 @@ Print Settings
Other settings control how different kinds of objects are printed:
-@table @code
+@table @kbd
@anchor{set print array}
@item set print array
@itemx set print array on
@@ -12764,7 +12764,7 @@ Print Settings
@noindent
These settings are of interest when debugging C@t{++} programs:
-@table @code
+@table @kbd
@cindex demangling C@t{++} names
@item set print demangle
@itemx set print demangle on
@@ -12961,7 +12961,7 @@ Pretty-Printer Commands
@subsection Pretty-Printer Commands
@cindex pretty-printer commands
-@table @code
+@table @kbd
@kindex info pretty-printer
@item info pretty-printer [@var{object-regexp} [@var{name-regexp}]]
Print the list of installed pretty-printers.
@@ -13123,7 +13123,7 @@ Value History
then the value recorded in the value history by the @code{print} command
remains 4 even though the value of @code{x} has changed.
-@table @code
+@table @kbd
@kindex show values
@item show values
Print the last ten values in the value history, with their item numbers.
@@ -13179,7 +13179,7 @@ Convenience Vars
that variable already has a value of a different type. The convenience
variable, when used as an expression, has the type of its current value.
-@table @code
+@table @kbd
@kindex show convenience
@cindex show all user variables and functions
@item show convenience
@@ -13740,7 +13740,7 @@ Convenience Funs
@value{GDBN} provides the ability to list and get help on
convenience functions.
-@table @code
+@table @kbd
@item help function
@kindex help function
@cindex show all convenience functions
@@ -13756,7 +13756,7 @@ Registers
for each machine; use @code{info registers} to see the names used on
your machine.
-@table @code
+@table @kbd
@kindex info registers
@item info registers
Print the names and values of all registers except floating-point
@@ -13918,7 +13918,7 @@ Floating Point Hardware
Depending on the configuration, @value{GDBN} may be able to give
you more information about the status of the floating point hardware.
-@table @code
+@table @kbd
@kindex info float
@item info float
Display hardware-dependent information about the floating
@@ -13934,7 +13934,7 @@ Vector Unit
Depending on the configuration, @value{GDBN} may be able to give you
more information about the status of the vector unit.
-@table @code
+@table @kbd
@kindex info vector
@item info vector
Display information about the vector unit. The exact contents and
@@ -13962,7 +13962,7 @@ OS Information
support of the @samp{qXfer:auxv:read} packet, see
@ref{qXfer auxiliary vector read}.
-@table @code
+@table @kbd
@kindex info auxv
@item info auxv
Display the auxiliary vector of the inferior, which can be either a
@@ -13982,7 +13982,7 @@ OS Information
functionality depends on the remote stub's support of the
@samp{qXfer:osdata:read} packet, see @ref{qXfer osdata read}.
-@table @code
+@table @kbd
@kindex info os
@item info os @var{infotype}
@@ -13991,7 +13991,7 @@ OS Information
On @sc{gnu}/Linux, the following values of @var{infotype} are valid:
@anchor{linux info os infotypes}
-@table @code
+@table @kbd
@kindex info os cpus
@item cpus
Display the list of all CPUs/cores. For each CPU/core, @value{GDBN} prints
@@ -14108,7 +14108,7 @@ Memory Region Attributes
When a memory region is defined, it is given a number to identify it;
to enable, disable, or remove a memory region, you specify that number.
-@table @code
+@table @kbd
@kindex mem
@item mem @var{lower} @var{upper} @var{attributes}@dots{}
Define a memory region bounded by @var{lower} and @var{upper} with
@@ -14226,7 +14226,7 @@ Memory Region Attributes
regions has undesired effects for a specific target, or to provide
better error checking. The following commands control this behavior.
-@table @code
+@table @kbd
@kindex set mem inaccessible-by-default
@item set mem inaccessible-by-default [on|off]
If @code{on} is specified, make @value{GDBN} treat memory not
@@ -14265,7 +14265,7 @@ Dump/Restore Files
Tektronix Hex, or Verilog Hex format; however, @value{GDBN} can only
append to binary files, and cannot read from Verilog Hex files.
-@table @code
+@table @kbd
@kindex dump
@item dump @r{[}@var{format}@r{]} memory @var{filename} @var{start_addr} @var{end_addr}
@@ -14335,7 +14335,7 @@ Core File Generation
are debugging in order to preserve a snapshot of its state.
@value{GDBN} has a special command for that.
-@table @code
+@table @kbd
@kindex gcore
@kindex generate-core-file
@item generate-core-file [@var{file}]
@@ -14429,7 +14429,7 @@ Character Sets
Here are the commands for controlling @value{GDBN}'s character set
support:
-@table @code
+@table @kbd
@item set target-charset @var{charset}
@kindex set target-charset
Set the current target character set to @var{charset}. To display the
@@ -14640,7 +14640,7 @@ Caching Target Data
Other regions of memory can be explicitly marked as
cacheable; @pxref{Memory Region Attributes}.
-@table @code
+@table @kbd
@kindex set remotecache
@item set remotecache on
@itemx set remotecache off
@@ -14718,7 +14718,7 @@ Searching Memory
Memory can be searched for a particular sequence of bytes with the
@code{find} command.
-@table @code
+@table @kbd
@kindex find
@item find @r{[}/@var{sn}@r{]} @var{start_addr}, +@var{len}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]}
@itemx find @r{[}/@var{sn}@r{]} @var{start_addr}, @var{end_addr}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]}
@@ -14825,7 +14825,7 @@ Value Sizes
may indicate a value that is incorrectly large, this in turn may cause
@value{GDBN} to try and allocate an overly large amount of memory.
-@table @code
+@table @kbd
@anchor{set max-value-size}
@kindex set max-value-size
@item set max-value-size @var{bytes}
@@ -14996,7 +14996,7 @@ Tail Call Frames
tries to show at least all the unambiguous top tail callers and all the
unambiguous bottom tail callees, if any.
-@table @code
+@table @kbd
@anchor{set debug entry-values}
@item set debug entry-values
@kindex set debug entry-values
@@ -15138,7 +15138,7 @@ Macros
macro invocations present in the expression. @value{GDBN} also provides
the following commands for working with macros explicitly.
-@table @code
+@table @kbd
@kindex macro expand
@cindex macro expansion, showing the results of preprocessor
@@ -15479,7 +15479,7 @@ Set Tracepoints
@node Create and Delete Tracepoints
@subsection Create and Delete Tracepoints
-@table @code
+@table @kbd
@cindex set tracepoint
@kindex trace
@item trace @var{locspec}
@@ -15653,7 +15653,7 @@ Enable and Disable Tracepoints
These commands are deprecated; they are equivalent to plain @code{disable} and @code{enable}.
-@table @code
+@table @kbd
@kindex disable tracepoint
@item disable tracepoint @r{[}@var{num}@r{]}
Disable tracepoint @var{num}, or all tracepoints if no argument
@@ -15980,7 +15980,7 @@ Tracepoint Actions
@node Listing Tracepoints
@subsection Listing Tracepoints
-@table @code
+@table @kbd
@kindex info tracepoints @r{[}@var{n}@dots{}@r{]}
@kindex info tp @r{[}@var{n}@dots{}@r{]}
@cindex information about tracepoints
@@ -16031,7 +16031,7 @@ Listing Tracepoints
@node Listing Static Tracepoint Markers
@subsection Listing Static Tracepoint Markers
-@table @code
+@table @kbd
@kindex info static-tracepoint-markers
@cindex information about static tracepoint markers
@item info static-tracepoint-markers
@@ -16085,7 +16085,7 @@ Listing Static Tracepoint Markers
@node Starting and Stopping Trace Experiments
@subsection Starting and Stopping Trace Experiments
-@table @code
+@table @kbd
@kindex tstart [ @var{notes} ]
@cindex start a new trace experiment
@cindex collected data discarded
@@ -16147,7 +16147,7 @@ Starting and Stopping Trace Experiments
@code{disconnected-tracing} lets you decide whether the trace should
continue running without @value{GDBN}.
-@table @code
+@table @kbd
@item set disconnected-tracing on
@itemx set disconnected-tracing off
@kindex set disconnected-tracing
@@ -16192,7 +16192,7 @@ Starting and Stopping Trace Experiments
buffer handling on the fly, otherwise it will not take effect until
the next run.
-@table @code
+@table @kbd
@item set circular-trace-buffer on
@itemx set circular-trace-buffer off
@kindex set circular-trace-buffer
@@ -16210,7 +16210,7 @@ Starting and Stopping Trace Experiments
@end table
-@table @code
+@table @kbd
@item set trace-buffer-size @var{n}
@itemx set trace-buffer-size unlimited
@kindex set trace-buffer-size
@@ -16230,7 +16230,7 @@ Starting and Stopping Trace Experiments
to get a report of the actual buffer size.
@end table
-@table @code
+@table @kbd
@item set trace-user @var{text}
@kindex set trace-user
@@ -16371,7 +16371,7 @@ tfind
Here are the various forms of using the @code{tfind} command.
-@table @code
+@table @kbd
@item tfind start
Find the first snapshot in the buffer. This is a synonym for
@code{tfind 0} (since 0 is the number of the first snapshot).
@@ -16620,7 +16620,7 @@ Trace Files
dump the trace data into a file, and later use that file as a source
of trace data, via the @code{target tfile} command.
-@table @code
+@table @kbd
@kindex tsave
@item tsave [ -r ] @var{filename}
@@ -16816,7 +16816,7 @@ Overlay Commands
@value{GDBN}'s overlay commands all start with the word @code{overlay};
you can abbreviate this as @code{ov} or @code{ovly}. The commands are:
-@table @code
+@table @kbd
@item overlay off
@kindex overlay
Disable @value{GDBN}'s overlay support. When overlay support is
@@ -17197,7 +17197,7 @@ Automatically
The warning is enabled by default, but it can be controlled via a
setting:
-@table @code
+@table @kbd
@item set warn-language-frame-mismatch [on|off]
@kindex warn-language-frame-mismatch
Enable or disable the warning that is issued when the current language
@@ -17213,7 +17213,7 @@ Show
The following commands help you find out which language is the
working language, and also what language source files were written in.
-@table @code
+@table @kbd
@item show language
@anchor{show language}
@kindex show language
@@ -17239,7 +17239,7 @@ Show
not in the standard list. You can then set the extension associated
with a language explicitly:
-@table @code
+@table @kbd
@item set extension-language @var{ext} @var{language}
@kindex set extension-language
Tell @value{GDBN} that source files with extension @var{ext} are to be
@@ -17311,7 +17311,7 @@ Type Checking
@kindex set check type
@kindex show check type
-@table @code
+@table @kbd
@item set check type on
@itemx set check type off
Set strict type checking on or off. If any type mismatches occur in
@@ -17358,7 +17358,7 @@ Range Checking
@kindex set check range
@kindex show check range
-@table @code
+@table @kbd
@item set check range auto
Set range checking on or off based on the current working language.
@xref{Supported Languages, ,Supported Languages}, for the default settings for
@@ -17818,7 +17818,7 @@ Debugging C Plus Plus
Some @value{GDBN} commands are particularly useful with C@t{++}, and some are
designed specifically for use with C@t{++}. Here is a summary:
-@table @code
+@table @kbd
@cindex break in overloaded functions
@item @r{breakpoint menus}
When you want a breakpoint in a function whose name is overloaded,
@@ -18011,7 +18011,7 @@ Go
Here is a summary of the Go-specific features and restrictions:
-@table @code
+@table @asis
@cindex current Go package
@item The current Go package
The name of the current package does not need to be specified when
@@ -18379,7 +18379,7 @@ Special Fortran Commands
@value{GDBN} has some commands to support Fortran-specific features,
such as displaying common blocks.
-@table @code
+@table @kbd
@cindex @code{COMMON} blocks, Fortran
@kindex info common
@item info common @r{[}@var{common-name}@r{]}
@@ -19507,7 +19507,7 @@ Overloading support for Ada
Here are a couple of commands to customize @value{GDBN}'s behavior in this
case:
-@table @code
+@table @kbd
@kindex set ada print-signatures
@item set ada print-signatures
@@ -19540,7 +19540,7 @@ Ada Exceptions
A command is provided to list all Ada exceptions:
-@table @code
+@table @kbd
@kindex info exceptions
@item info exceptions
@itemx info exceptions @var{regexp}
@@ -19578,7 +19578,7 @@ Ada Tasks
Support for Ada tasks is analogous to that for threads (@pxref{Threads}).
@value{GDBN} provides the following task-related commands:
-@table @code
+@table @kbd
@kindex info tasks
@item info tasks
This command shows a list of current Ada tasks, as in the following example:
@@ -19859,7 +19859,7 @@ Ravenscar Profile
specifically designed for systems with safety-critical real-time
requirements.
-@table @code
+@table @kbd
@kindex set ravenscar task-switching on
@cindex task switching with program using Ravenscar Profile
@item set ravenscar task-switching on
@@ -19917,7 +19917,7 @@ Ada Source Character Set
files. @xref{Character Set Control, , Character Set Control,
gnat_ugn}. @value{GDBN} includes support for this as well.
-@table @code
+@table @kbd
@item set ada source-charset @var{charset}
@kindex set ada source-charset
Set the source character set for Ada. The character set must be
@@ -19981,7 +19981,7 @@ Ada Glitches
@kindex set ada trust-PAD-over-XVS
@kindex show ada trust-PAD-over-XVS
-@table @code
+@table @kbd
@item set ada trust-PAD-over-XVS on
Configure GDB to strictly follow the GNAT encoding when computing the
@@ -20018,7 +20018,7 @@ Ada Glitches
those descriptive types. It allows the user to quickly evaluate how
well @value{GDBN} works without them.
-@table @code
+@table @kbd
@kindex maint ada set ignore-descriptive-types
@item maintenance ada set ignore-descriptive-types [on|off]
@@ -20078,7 +20078,7 @@ Symbols
@noindent
looks up the value of @code{x} in the scope of the file @file{foo.c}.
-@table @code
+@table @kbd
@cindex case-insensitive symbol names
@cindex case sensitivity in symbol names
@kindex set case-sensitive
@@ -21127,7 +21127,7 @@ Jumping
it stopped, with the @code{continue} command. You can instead continue at
an address of your own choosing, with the following commands:
-@table @code
+@table @kbd
@kindex jump
@kindex j @r{(@code{jump})}
@item jump @var{locspec}
@@ -21188,7 +21188,7 @@ Signaling
@section Giving your Program a Signal
@cindex deliver a signal to a program
-@table @code
+@table @kbd
@kindex signal
@item signal @var{signal}
Resume execution where your program is stopped, but immediately give it the
@@ -21250,7 +21250,7 @@ Signaling
@node Returning
@section Returning from a Function
-@table @code
+@table @kbd
@cindex returning from a function
@kindex return
@item return
@@ -21328,7 +21328,7 @@ Returning
@node Calling
@section Calling Program Functions
-@table @code
+@table @kbd
@cindex calling functions
@cindex inferior functions, calling
@item print @var{expr}
@@ -21365,7 +21365,7 @@ Calling
@code{set unwind-on-terminating-exception} command.
@anchor{stack unwind settings}
-@table @code
+@table @kbd
@item set unwind-on-signal
@kindex set unwind-on-signal
@kindex set unwindonsignal
@@ -21494,7 +21494,7 @@ Calling
indefinitely for function call to complete, unless interrupted by the
user using @kbd{Ctrl-C}.
-@table @code
+@table @kbd
@item set direct-call-timeout @var{seconds}
@kindex set direct-call-timeout
@cindex timeout for called functions
@@ -21523,7 +21523,7 @@ Calling
Conditions}). A different setting controls the timeout used for
function calls made from a breakpoint condition.
-@table @code
+@table @kbd
@item set indirect-call-timeout @var{seconds}
@kindex set indirect-call-timeout
@cindex timeout for called functions
@@ -21633,7 +21633,7 @@ Patching
want to turn on internal debugging flags, or even to make emergency
repairs.
-@table @code
+@table @kbd
@kindex set write
@item set write on
@itemx set write off
@@ -21662,7 +21662,7 @@ Compiling and Injecting Code
@file{libcc1.so} must be installed for this functionality to be enabled.
This functionality is implemented with the following commands.
-@table @code
+@table @kbd
@kindex compile code
@item compile code @var{source-code}
@itemx compile code -raw @var{--} @var{source-code}
@@ -21728,7 +21728,7 @@ Compiling and Injecting Code
@ref{Filename Arguments,,Filenames As Command Arguments}.
@end table
-@table @code
+@table @kbd
@item compile print [[@var{options}] --] @var{expr}
@itemx compile print [[@var{options}] --] /@var{f} @var{expr}
Compile and execute @var{expr} with the compiler language found as the
@@ -21751,7 +21751,7 @@ Compiling and Injecting Code
@noindent
The process of compiling and injecting the code can be inspected using:
-@table @code
+@table @kbd
@anchor{set debug compile}
@item set debug compile
@cindex compile command debugging info
@@ -21804,7 +21804,7 @@ Compiling and Injecting Code
@noindent
You can override compilation options using the following command:
-@table @code
+@table @kbd
@item set compile-args
@cindex compile command options override
Set compilation options used for compiling and injecting code with the
@@ -22003,7 +22003,7 @@ Compiling and Injecting Code
according to the installation of the found compiler --- as possibly
specified by the @code{set compile-gcc} command.
-@table @code
+@table @kbd
@item set compile-gcc
@cindex compile command driver filename override
Set compilation command used for compiling and injecting code with the
@@ -22054,7 +22054,7 @@ Files
Program}). In these situations the @value{GDBN} commands to specify
new files are useful.
-@table @code
+@table @kbd
@cindex executable file
@kindex file
@item file @var{filename}
@@ -22426,7 +22426,7 @@ Files
To control the automatic loading of shared library symbols, use the
commands:
-@table @code
+@table @kbd
@kindex set auto-solib-add
@item set auto-solib-add @var{mode}
If @var{mode} is @code{on}, symbols from all shared object libraries
@@ -22455,7 +22455,7 @@ Files
To explicitly load shared library symbols, use the @code{sharedlibrary}
command:
-@table @code
+@table @kbd
@kindex info sharedlibrary
@kindex info share
@item info share @var{regex}
@@ -22516,7 +22516,7 @@ Files
less useful than setting a catchpoint, because it does not allow for
conditions or commands as a catchpoint does.
-@table @code
+@table @kbd
@kindex info linker-namespaces
@item info linker-namespaces
@item info linker-namespaces @code{[[@var{n}]]}
@@ -22532,7 +22532,7 @@ Files
The surrounding square brackets are optional.
@end table
-@table @code
+@table @kbd
@item set stop-on-solib-events @r{[}on@r{|}off@r{]}
@kindex set stop-on-solib-events
This command controls whether @value{GDBN} should give you control
@@ -22561,7 +22561,7 @@ Files
may try to load the host's libraries. @value{GDBN} has two variables
to specify the search directories for target libraries.
-@table @code
+@table @kbd
@cindex prefix for executable and shared library file names
@cindex system root, alternate
@kindex set solib-absolute-prefix
@@ -22747,7 +22747,7 @@ Files
pair of file names it needs to compare. This will make file-name
comparisons accurate, but at a price of a significant slowdown.
-@table @code
+@table @kbd
@item set basenames-may-differ
@kindex set basenames-may-differ
Set whether a source file may have multiple base names.
@@ -22767,7 +22767,7 @@ File Caching
BFD, bfd, The Binary File Descriptor Library}. The following commands
allow visibility and control of the caching behavior.
-@table @code
+@table @kbd
@kindex maint info bfds
@item maint info bfds
This prints information about each @code{bfd} object that is known to
@@ -22898,7 +22898,7 @@ Separate Debug Files
also set the global debugging info directories, and view the list
@value{GDBN} is currently using.
-@table @code
+@table @kbd
@kindex set debug-file-directory
@item set debug-file-directory @var{directories}
@@ -23197,7 +23197,7 @@ Index Files
To create an index file, use the @code{save gdb-index} command:
-@table @code
+@table @kbd
@item save gdb-index [-dwarf-5] @var{directory}
@kindex save gdb-index
Create index files for all symbol files currently known by
@@ -23264,7 +23264,7 @@ Index Files
so files without build ID will not have their index cached.
The following commands can be used to tweak the behavior of the index cache.
-@table @code
+@table @kbd
@kindex set index-cache
@item set index-cache enabled on
@@ -23511,7 +23511,7 @@ Data Files
You can set the data directory's name, and view the name @value{GDBN}
is currently using.
-@table @code
+@table @kbd
@kindex set data-directory
@item set data-directory @var{directory}
Set the directory which @value{GDBN} searches for auxiliary data files
@@ -23556,7 +23556,7 @@ Targets
one of the available architectures with the @kbd{set architecture}
command.
-@table @code
+@table @kbd
@kindex set architecture
@kindex show architecture
@item set architecture @var{arch}
@@ -23606,7 +23606,7 @@ Active Targets
@node Target Commands
@section Commands for Managing Targets
-@table @code
+@table @kbd
@item target @var{type} @var{parameters}
Connects the @value{GDBN} host environment to a target machine or
process. A target is typically a protocol for talking to debugging
@@ -23658,7 +23658,7 @@ Target Commands
Here are some common targets (available, or not, depending on the GDB
configuration):
-@table @code
+@table @kbd
@kindex target
@item target exec @var{program}
@cindex executable file target
@@ -23752,7 +23752,7 @@ Target Commands
@value{GDBN} and the remote monitor.
@end table
-@table @code
+@table @kbd
@kindex load @var{filename} @var{offset}
@item load @var{filename} @var{offset}
@@ -23784,7 +23784,7 @@ Target Commands
@code{load} does not repeat if you press @key{RET} again after using it.
@end table
-@table @code
+@table @kbd
@kindex flash-erase
@item flash-erase
@@ -23807,7 +23807,7 @@ Byte Order
which to use. However, you may still find it useful to adjust
@value{GDBN}'s idea of processor endian-ness manually.
-@table @code
+@table @kbd
@kindex set endian
@item set endian big
Instruct @value{GDBN} to assume the target is big-endian.
@@ -24013,7 +24013,7 @@ Connecting
establish a connection to the target. Both commands accept the same
arguments, which indicate the medium to use:
-@table @code
+@table @kbd
@item target remote @var{serial-device}
@itemx target extended-remote @var{serial-device}
@@ -24173,7 +24173,7 @@ Connecting
In @code{target extended-remote} mode, typing @kbd{n} will leave
@value{GDBN} connected to the target.
-@table @code
+@table @kbd
@kindex detach (remote)
@item detach
When you have finished debugging the remote program, you can use the
@@ -24219,7 +24219,7 @@ File Transfer
Not all remote targets support these commands.
-@table @code
+@table @kbd
@kindex remote put
@item remote put @var{hostfile} @var{targetfile}
Copy file @var{hostfile} from the host system (the machine running
@@ -24539,7 +24539,7 @@ Server
@code{monitor} command to send special requests to @code{gdbserver}.
Here are the available commands.
-@table @code
+@table @kbd
@item monitor help
List the available monitor commands.
@@ -24620,7 +24620,7 @@ Server
There are several ways to load the in-process agent in your program:
-@table @code
+@table @asis
@item Specifying it as dependency at link time
You can link your program dynamically with the in-process agent
@@ -24694,7 +24694,7 @@ Remote Configuration
extensions of the remote protocol, see @ref{system,
system-call-allowed}.
-@table @code
+@table @kbd
@item set remoteaddresssize @var{bits}
@cindex address size for remote targets
@cindex bits in remote address
@@ -25242,7 +25242,7 @@ Remote Stub
@cindex remote serial stub list
These working remote stubs are distributed with @value{GDBN}:
-@table @code
+@table @file
@item i386-stub.c
@cindex @file{i386-stub.c}
@@ -25597,7 +25597,7 @@ Process Information
currently available from cores created on @sc{gnu}/Linux and FreeBSD
systems.
-@table @code
+@table @kbd
@kindex info proc
@cindex process ID
@item info proc
@@ -25763,7 +25763,7 @@ DJGPP Native
defines a few commands specific to the @sc{djgpp} port. This
subsection describes those commands.
-@table @code
+@table @kbd
@kindex info dos
@item info dos
This is a prefix of @sc{djgpp}-specific commands which print
@@ -25894,7 +25894,7 @@ DJGPP Native
debugging via a serial data link. The following commands are specific
to remote serial debugging in the DJGPP port of @value{GDBN}.
-@table @code
+@table @kbd
@kindex set com1base
@kindex set com1irq
@kindex set com2base
@@ -25959,7 +25959,7 @@ Cygwin Native
this section. Working with DLLs that have no debugging symbols is
described in @ref{Non-debug DLL Symbols}.
-@table @code
+@table @kbd
@kindex info w32
@item info w32
This is a prefix of MS Windows-specific commands which print
@@ -26206,7 +26206,7 @@ Hurd Native
This subsection describes @value{GDBN} commands specific to the
@sc{gnu} Hurd native debugging.
-@table @code
+@table @kbd
@item set signals
@itemx set sigs
@kindex set signals@r{, Hurd command}
@@ -26378,7 +26378,7 @@ Darwin
@value{GDBN} provides the following commands specific to the Darwin target:
-@table @code
+@table @kbd
@item set debug darwin @var{num}
@kindex set debug darwin
When set to a non zero value, enables debugging messages specific to
@@ -26456,7 +26456,7 @@ Embedded Processors
Whenever a specific embedded processor has a simulator, @value{GDBN}
allows to send an arbitrary command to the simulator.
-@table @code
+@table @kbd
@item sim @var{command}
@kindex sim@r{, a command}
Send an arbitrary @var{command} string to the simulator. Consult the
@@ -26490,7 +26490,7 @@ ARC
@value{GDBN} provides the following ARC-specific commands:
-@table @code
+@table @kbd
@item set debug arc
@kindex set debug arc
Control the level of ARC specific debug messages. Use 0 for no messages (the
@@ -26511,7 +26511,7 @@ ARM
@value{GDBN} provides the following ARM-specific commands:
-@table @code
+@table @kbd
@item set arm disassembler
@kindex set arm
This commands selects from a list of disassembly styles. The
@@ -26593,7 +26593,7 @@ ARM
Show whether ARM-specific debugging messages are enabled.
@end table
-@table @code
+@table @kbd
@item target sim @r{[}@var{simargs}@r{]} @dots{}
The @value{GDBN} ARM simulator accepts the following optional arguments.
@@ -26616,7 +26616,7 @@ ARM
@node BPF
@subsection BPF
-@table @code
+@table @kbd
@item target sim @r{[}@var{simargs}@r{]} @dots{}
The @value{GDBN} BPF simulator accepts the following optional arguments.
@@ -26653,7 +26653,7 @@ MicroBlaze
Use these GDB commands to connect to the MicroBlaze target processor.
-@table @code
+@table @kbd
@item target remote :1234
Use this command to connect to the target if you are running @value{GDBN}
on the same system as @code{xmd}.
@@ -26678,7 +26678,7 @@ MIPS Embedded
@noindent
@value{GDBN} supports these special commands for @acronym{MIPS} targets:
-@table @code
+@table @kbd
@item set mipsfpu double
@itemx set mipsfpu single
@itemx set mipsfpu none
@@ -26720,7 +26720,7 @@ OpenRISC 1000
@value{GDBN} for OpenRISC supports the below commands when connecting to
a target:
-@table @code
+@table @kbd
@kindex target sim
@item target sim
@@ -26784,7 +26784,7 @@ PowerPC Embedded
@value{GDBN} provides the following PowerPC-specific commands:
-@table @code
+@table @kbd
@kindex break-range
@item break-range @var{start-locspec}, @var{end-locspec}
Set a breakpoint for an address range given by @var{start-locspec} and
@@ -26830,7 +26830,7 @@ AVR
When configured for debugging the Atmel AVR, @value{GDBN} supports the
following AVR-specific commands:
-@table @code
+@table @kbd
@item info io_registers
@kindex info io_registers@r{, AVR}
@cindex I/O registers (Atmel AVR)
@@ -26845,7 +26845,7 @@ CRIS
When configured for debugging CRIS, @value{GDBN} provides the
following CRIS-specific commands:
-@table @code
+@table @kbd
@item set cris-version @var{ver}
@cindex CRIS version
Set the current CRIS version to @var{ver}, either @samp{10} or @samp{32}.
@@ -26881,7 +26881,7 @@ Super-H
For the Renesas Super-H processor, @value{GDBN} provides these
commands:
-@table @code
+@table @kbd
@item set sh calling-convention @var{convention}
@kindex set sh calling-convention
Set the calling-convention used when calling functions from @value{GDBN}.
@@ -26928,7 +26928,7 @@ AArch64
When @value{GDBN} is debugging the AArch64 architecture, it provides the
following special commands:
-@table @code
+@table @kbd
@item set debug aarch64
@kindex set debug aarch64
This command determines whether AArch64 architecture-specific debugging
@@ -27370,7 +27370,7 @@ AArch64
@node x86
@subsection x86
-@table @code
+@table @kbd
@item set struct-convention @var{mode}
@kindex set struct-convention
@cindex struct return convention
@@ -27470,7 +27470,7 @@ MIPS
you may want to limit the size of this search, using one of these
commands:
-@table @code
+@table @kbd
@cindex @code{heuristic-fence-post} (Alpha, @acronym{MIPS})
@item set heuristic-fence-post @var{limit}
Restrict @value{GDBN} to examining at most @var{limit} bytes in its
@@ -27491,7 +27491,7 @@ MIPS
Several @acronym{MIPS}-specific commands are available when debugging @acronym{MIPS}
programs:
-@table @code
+@table @kbd
@item set mips abi @var{arg}
@kindex set mips abi
@cindex set ABI for @acronym{MIPS}
@@ -27592,7 +27592,7 @@ HPPA
When @value{GDBN} is debugging the HP PA architecture, it provides the
following special commands:
-@table @code
+@table @kbd
@item set debug hppa
@kindex set debug hppa
This command determines whether HPPA architecture-specific debugging
@@ -27651,7 +27651,7 @@ Sparc64
cacheline (64 bytes), can be viewed or modified.
-@table @code
+@table @kbd
@kindex adi examine
@item adi (examine | x) [ / @var{n} ] @var{addr}
@@ -27705,7 +27705,7 @@ S12Z
When @value{GDBN} is debugging the S12Z architecture,
it provides the following special command:
-@table @code
+@table @kbd
@item maint info bdccsr
@kindex maint info bdccsr@r{, S12Z}
This command displays the current value of the microprocessor's
@@ -27904,7 +27904,7 @@ AMD GPU
being incorrect. The following commands can be used to control this
behavior:
-@table @code
+@table @kbd
@kindex set amdgpu precise-memory
@cindex AMD GPU precise memory event reporting
@@ -28016,7 +28016,7 @@ RISC-V
When @value{GDBN} is debugging a RISC-V architecture, it provides the
following special commands:
-@table @code
+@table @kbd
@item set riscv numeric-register-names @r{[}on@r{|}off@r{]}
@kindex set riscv numeric-register-names
This command controls whether @value{GDBN} displays RISC-V register names using
@@ -28069,7 +28069,7 @@ Prompt
prompt you set. This allows you to set a prompt which ends in a space
or a prompt that does not.
-@table @code
+@table @kbd
@kindex set prompt
@item set prompt @var{newprompt}
Directs @value{GDBN} to use @var{newprompt} as its prompt string henceforth.
@@ -28093,7 +28093,7 @@ Prompt
prompt extensions. The commands for interacting with these extensions
are:
-@table @code
+@table @kbd
@kindex set extended-prompt
@item set extended-prompt @var{prompt}
Set an extended prompt that allows for substitutions.
@@ -28133,7 +28133,7 @@ Editing
You may control the behavior of command line editing in @value{GDBN} with the
command @code{set}.
-@table @code
+@table @kbd
@kindex set editing
@cindex editing
@item set editing
@@ -28207,7 +28207,7 @@ Command History
Here is the description of @value{GDBN} commands related to command
history.
-@table @code
+@table @kbd
@cindex history substitution
@cindex history file
@kindex set history filename
@@ -28310,7 +28310,7 @@ Command History
The commands to control history expansion are:
-@table @code
+@table @kbd
@item set history expansion on
@itemx set history expansion
@kindex set history expansion
@@ -28331,7 +28331,7 @@ Command History
@c @end group
@end table
-@table @code
+@table @kbd
@kindex show commands
@cindex show last commands
@cindex display command history
@@ -28371,7 +28371,7 @@ Screen Size
you can override it with the @code{set height} and @code{set
width} commands:
-@table @code
+@table @kbd
@kindex set height
@kindex set width
@kindex show width
@@ -28419,7 +28419,7 @@ Output Styling
batch mode (@pxref{Mode Options}). Various style settings are available;
and styles can also be disabled entirely.
-@table @code
+@table @kbd
@item set style enabled @samp{on|off}
Enable or disable all styling. The default is host-dependent, with
most hosts defaulting to @samp{on}.
@@ -28525,7 +28525,7 @@ Output Styling
For example, the style of file names can be controlled using the
@code{set style filename} group of commands:
-@table @code
+@table @kbd
@item set style filename background @var{color}
Set the background to @var{color}. @var{color} can be @samp{none}
(meaning the terminal's default color), a name of one of the eight standard
@@ -28707,7 +28707,7 @@ Numbers
format is specified---is base 10. You can change the default base for
both input and output with the commands described below.
-@table @code
+@table @kbd
@kindex set input-radix
@item set input-radix @var{base}
Set the default base for numeric input. Supported choices
@@ -28790,7 +28790,7 @@ ABI
the @code{--target} configure option) when that is a Windows flavor,
and otherwise assumes the GNU flavor. @xref{Configure Options}.
-@table @code
+@table @kbd
@item show osabi
Show the OS ABI currently in use.
@@ -28814,7 +28814,7 @@ ABI
a function is prototyped. If @value{GDBN} calls a function that is not marked
as prototyped, it consults @kbd{set coerce-float-to-double}.
-@table @code
+@table @kbd
@kindex set coerce-float-to-double
@item set coerce-float-to-double
@itemx set coerce-float-to-double on
@@ -28844,7 +28844,7 @@ ABI
use the ``gnu-v2'' or ``gnu-v3'' ABI's as well. The default setting is
``auto''.
-@table @code
+@table @kbd
@item show cp-abi
Show the C@t{++} ABI currently in use.
@@ -28878,7 +28878,7 @@ Auto-loading
For these reasons, @value{GDBN} includes commands and options to let you
control when to auto-load files and which files should be auto-loaded.
-@table @code
+@table @kbd
@anchor{set auto-load off}
@kindex set auto-load off
@item set auto-load off
@@ -29007,7 +29007,7 @@ Init File in the Current Directory
Note that loading of this local @file{.gdbinit} file also requires accordingly
configured @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
-@table @code
+@table @kbd
@anchor{set auto-load local-gdbinit}
@kindex set auto-load local-gdbinit
@item set auto-load local-gdbinit [on|off]
@@ -29046,7 +29046,7 @@ libthread_db.so.1 file
Note that loading of this debugging library also requires accordingly configured
@code{auto-load safe-path} (@pxref{Auto-loading safe path}).
-@table @code
+@table @kbd
@anchor{set auto-load libthread-db}
@kindex set auto-load libthread-db
@item set auto-load libthread-db [on|off]
@@ -29099,7 +29099,7 @@ Auto-loading safe path
The list of trusted directories is controlled by the following commands:
-@table @code
+@table @kbd
@anchor{set auto-load safe-path}
@kindex set auto-load safe-path
@item set auto-load safe-path @r{[}@var{directories}@r{]}
@@ -29214,7 +29214,7 @@ Auto-loading verbose mode
by your `auto-load safe-path' set to "/usr:/opt".
@end smallexample
-@table @code
+@table @kbd
@anchor{set debug auto-load}
@kindex set debug auto-load
@item set debug auto-load [on|off]
@@ -29241,7 +29241,7 @@ Messages/Warnings
which announce that the symbol table for a source file is being read;
see @code{symbol-file} in @ref{Files, ,Commands to Specify Files}.
-@table @code
+@table @kbd
@kindex set verbose
@item set verbose on
Enables @value{GDBN} output of certain informational messages.
@@ -29259,7 +29259,7 @@ Messages/Warnings
find this information useful (@pxref{Symbol Errors, ,Errors Reading
Symbol Files}).
-@table @code
+@table @kbd
@kindex set complaints
@item set complaints @var{limit}
@@ -29288,7 +29288,7 @@ Messages/Warnings
If you are willing to unflinchingly face the consequences of your own
commands, you can disable this ``feature'':
-@table @code
+@table @kbd
@kindex set confirm
@cindex flinching
@@ -29314,7 +29314,7 @@ Messages/Warnings
printed as it is executed, prefixed with one or more @samp{+} symbols, the
quantity denoting the call depth of each command.
-@table @code
+@table @kbd
@kindex set trace-commands
@cindex command scripts, debugging
@item set trace-commands on
@@ -29334,7 +29334,7 @@ Debugging Output
interest to @value{GDBN} maintainers, or when reporting a bug. This
section documents those commands.
-@table @code
+@table @kbd
@kindex set exec-done-display
@item set exec-done-display
Turns on or off the notification of asynchronous commands'
@@ -29725,7 +29725,7 @@ Other Misc Settings
@section Other Miscellaneous Settings
@cindex miscellaneous settings
-@table @code
+@table @kbd
@kindex set interactive-mode
@item set interactive-mode
If @code{on}, forces @value{GDBN} to assume that GDB was started
@@ -29747,7 +29747,7 @@ Other Misc Settings
Displays whether the debugger is operating in interactive mode or not.
@end table
-@table @code
+@table @kbd
@kindex set suppress-cli-notifications
@item set suppress-cli-notifications
If @code{on}, command-line-interface (CLI) notifications that are
@@ -29862,7 +29862,7 @@ Extending GDB
You can control how @value{GDBN} evaluates these files with the following
setting:
-@table @code
+@table @kbd
@kindex set script-extension
@kindex show script-extension
@item set script-extension off
@@ -29987,7 +29987,7 @@ Define
end
@end smallexample
-@table @code
+@table @kbd
@kindex define
@item define @var{commandname}
@@ -30216,7 +30216,7 @@ Command Files
using the @code{script-extension} setting.
@xref{Extending GDB,, Extending GDB}.
-@table @code
+@table @kbd
@kindex source
@cindex execute commands from a file
@item source [-s] [-v] @var{filename}
@@ -30283,7 +30283,7 @@ Command Files
complex scripts that loop over data structures, execute commands
conditionally, etc.
-@table @code
+@table @kbd
@kindex if
@kindex else
@item if
@@ -30334,7 +30334,7 @@ Output
describes three commands useful for generating exactly the output you
want.
-@table @code
+@table @kbd
@kindex echo
@item echo @var{text}
@c I do not consider backslash-space a standard C escape sequence
@@ -30521,7 +30521,7 @@ Auto-loading sequences
Auto-loading can be enabled or disabled,
and the list of auto-loaded scripts can be printed.
-@table @code
+@table @kbd
@anchor{set auto-load gdb-scripts}
@kindex set auto-load gdb-scripts
@item set auto-load gdb-scripts [on|off]
@@ -30563,7 +30563,7 @@ Aliases
You can define a new alias with the @samp{alias} command.
-@table @code
+@table @kbd
@kindex alias
@item alias [-a] [--] @var{alias} = @var{command} [@var{default-args}]
@@ -30792,12 +30792,12 @@ objfile-gdbdotext file
where @var{objfile} is the object file's name and
where @var{ext} is the file extension for the extension language:
-@table @code
-@item @file{@var{objfile}-gdb.gdb}
+@table @file
+@item @var{objfile}-gdb.gdb
GDB's own command language
-@item @file{@var{objfile}-gdb.py}
+@item @var{objfile}-gdb.py
Python
-@item @file{@var{objfile}-gdb.scm}
+@item @var{objfile}-gdb.scm
Guile
@end table
@@ -30824,7 +30824,7 @@ objfile-gdbdotext file
is attempted on any platform. This makes the script filenames compatible
between Unix and MS-Windows hosts.
-@table @code
+@table @kbd
@anchor{set auto-load scripts-directory}
@kindex set auto-load scripts-directory
@item set auto-load scripts-directory @r{[}@var{directories}@r{]}
@@ -31537,7 +31537,7 @@ TUI Commands
these commands will fail with an error, because it would not be
possible or desirable to enable curses window management.
-@table @code
+@table @kbd
@item tui enable
@kindex tui enable
Activate TUI mode. The last active TUI window layout will be used if
@@ -31741,7 +31741,7 @@ TUI Configuration
Several configuration variables control the appearance of TUI windows.
-@table @code
+@table @kbd
@item set tui border-kind @var{kind}
@kindex set tui border-kind
Select the border appearance for the source, assembly and register windows.
@@ -32068,7 +32068,7 @@ Asynchronous and non-stop modes
find if asynchronous execution is enabled using the
@code{-list-target-features} command.
-@table @code
+@table @kbd
@cindex foreground execution
@cindex background execution
@cindex asynchronous execution
@@ -40151,7 +40151,7 @@ Annotations Overview
been made obsolete (@pxref{Limitations, , Limitations of the Annotation
Interface, annotate, GDB's Obsolete Annotations}).
-@table @code
+@table @kbd
@kindex set annotate
@item set annotate @var{level}
The @value{GDBN} command @code{set annotate} sets the level of
@@ -40535,7 +40535,7 @@ Debugger Adapter Protocol
DAP mode. These can be set on the command line using the @code{-iex}
option (@pxref{File Options}).
-@table @code
+@table @kbd
@item set debug dap-log-file @r{[}@var{filename}@r{]}
Enable DAP logging. Logs are written to @var{filename}. If no
@var{filename} is given, logging is stopped.
@@ -40716,7 +40716,7 @@ Using JIT Debug Info Readers
Readers can be loaded and unloaded using the @code{jit-reader-load}
and @code{jit-reader-unload} commands.
-@table @code
+@table @kbd
@item jit-reader-load @var{reader}
Load the JIT reader named @var{reader}, which is a shared
object specified as either an absolute or a relative file name. In
@@ -40839,7 +40839,7 @@ In-Process Agent
You can control whether the in-process agent is used as an aid for
debugging with the following commands:
-@table @code
+@table @kbd
@kindex set agent on
@item set agent on
Causes the in-process agent to perform some operations on behalf of the
@@ -41277,7 +41277,7 @@ In Memoriam
The @value{GDBN} project mourns the loss of the following long-time
contributors:
-@table @code
+@table @asis
@item Fred Fish
Fred was a long-standing contributor to @value{GDBN} (1991-2006), and
to Free Software in general. Outside of @value{GDBN}, he was known in
@@ -41564,7 +41564,7 @@ Running Configure
For example, the @value{GDBN} version @value{GDBVN} distribution is in the
@file{gdb-@value{GDBVN}} directory. That directory contains:
-@table @code
+@table @file
@item gdb-@value{GDBVN}/configure @r{(and supporting files)}
script for configuring @value{GDBN} and all its supporting libraries
@@ -41769,7 +41769,7 @@ Configure Options
@samp{--} if you prefer; but you may abbreviate option names if you use
@samp{--}.
-@table @code
+@table @option
@item --help
Display a quick summary of how to invoke @file{configure}.
@@ -41806,7 +41806,7 @@ Configure Options
lists just the most common ones; there are some very specialized
options not described here.
-@table @code
+@table @option
@item --enable-targets=@r{[}@var{target}@r{]}@dots{}
@itemx --enable-targets=all
Configure @value{GDBN} for cross-debugging programs running on the
@@ -41984,7 +41984,7 @@ System-wide configuration
Here are the corresponding configure options:
-@table @code
+@table @option
@item --with-system-gdbinit=@var{file}
Specify that the default location of the system-wide init file is
@var{file}.
@@ -42079,7 +42079,7 @@ Maintenance Commands
provided here for reference. (For commands that turn on debugging
messages, see @ref{Debugging Output}.)
-@table @code
+@table @kbd
@kindex maint agent
@kindex maint agent-eval
@item maint agent @r{[}-at @var{linespec}@r{,}@r{]} @var{expression}
@@ -42282,7 +42282,7 @@ Maintenance Commands
an out-of-line copy of the instruction that was originally at the
breakpoint location. It is also known as out-of-line single-stepping.
-@table @code
+@table @kbd
@item set displaced-stepping on
If the target architecture supports it, @value{GDBN} will use
displaced stepping to step over breakpoints.
@@ -43064,7 +43064,7 @@ Maintenance Commands
it can be changed to more easily debug problems occurring only in a
specific mode.
-@table @code
+@table @kbd
@item maint set target-non-stop auto
This is the default mode. @value{GDBN} controls the target in
non-stop mode if @code{set non-stop} is @code{on}, or the target tells
@@ -43083,8 +43083,8 @@ Maintenance Commands
Here is how @code{set non-stop} and @code{maint set target-non-stop}
settings combine:
-@table @code
-@item @code{set non-stop off}, target operating in all-stop mode
+@table @asis
+@item @kbd{set non-stop off}, target operating in all-stop mode
When a thread hits a breakpoint, finishes a step, etc., the target
stops all threads, and reports the event to the infrun module in the
core of @value{GDBN}. If infrun decides the stop is not to be seen by
@@ -43092,7 +43092,7 @@ Maintenance Commands
threads stop and are re-resumed for every debug event, even for debug
events that are internal and do not cause a user-visible stop.
-@item @code{set non-stop off}, target operating in non-stop mode
+@item @kbd{set non-stop off}, target operating in non-stop mode
When a thread hits a breakpoint, finishes a step, etc., the target
does not immediately stop all other threads. If, while processing the
event, infrun decides the stop should be reported to the user, it then
@@ -43100,10 +43100,10 @@ Maintenance Commands
user; otherwise, infrun re-resumes the stopped thread. This scenario
is also called ``all-stop on top of non-stop''.
-@item @code{set non-stop on}, target operating in all-stop mode
+@item @kbd{set non-stop on}, target operating in all-stop mode
This combination is invalid.
-@item @code{set non-stop on}, target operating in non-stop mode
+@item @kbd{set non-stop on}, target operating in non-stop mode
When a thread hits a breakpoint, finishes a step, etc., neither the
target, nor infrun stop any other thread.
@end table
@@ -43141,7 +43141,7 @@ Maintenance Commands
@value{GDBN} can display the resources used by each command.
This is useful in debugging performance problems.
-@table @code
+@table @kbd
@item maint set per-command space [on|off]
@itemx maint show per-command space
Enable or disable the printing of the memory used by GDB for each command.
@@ -43372,7 +43372,7 @@ Maintenance Commands
The following command is useful for non-interactive invocations of
@value{GDBN}, such as in the test suite.
-@table @code
+@table @kbd
@item set watchdog @var{nsec}
@kindex set watchdog
@cindex watchdog timer
@@ -48669,7 +48669,7 @@ system
by @value{GDBN}. The user has to allow this call explicitly with the
@code{set remote system-call-allowed 1} command.
-@table @code
+@table @kbd
@item set remote system-call-allowed
@kindex set remote system-call-allowed
Control whether to allow the @code{system} calls in the File I/O
@@ -49486,7 +49486,7 @@ Retrieving Descriptions
If a file is set, the target will not be queried. The commands to
specify a file are:
-@table @code
+@table @kbd
@cindex set tdesc filename
@item set tdesc filename @var{path}
Read the target description from @var{path}.
@@ -50936,17 +50936,17 @@ M68K Features
@subsection M68K Features
@cindex target descriptions, M68K features
-@table @code
-@item @samp{org.gnu.gdb.m68k.core}
-@itemx @samp{org.gnu.gdb.coldfire.core}
-@itemx @samp{org.gnu.gdb.fido.core}
+@table @samp
+@item org.gnu.gdb.m68k.core
+@itemx org.gnu.gdb.coldfire.core
+@itemx org.gnu.gdb.fido.core
One of those features must be always present.
The feature that is present determines which flavor of m68k is
used. The feature that is present should contain registers
@samp{d0} through @samp{d7}, @samp{a0} through @samp{a5}, @samp{fp},
@samp{sp}, @samp{ps} and @samp{pc}.
-@item @samp{org.gnu.gdb.coldfire.fp}
+@item org.gnu.gdb.coldfire.fp
This feature is optional. If present, it should contain registers
@samp{fp0} through @samp{fp7}, @samp{fpcontrol}, @samp{fpstatus} and
@samp{fpiaddr}.
@@ -51655,7 +51655,7 @@ Debuginfod Settings
@value{GDBN} provides the following commands for configuring @code{debuginfod}.
-@table @code
+@table @kbd
@kindex set debuginfod enabled
@anchor{set debuginfod enabled}
@item set debuginfod enabled
@@ -51807,7 +51807,7 @@ gdb man
Here are some of the most frequently needed @value{GDBN} commands:
@c pod2man highlights the right hand side of the @item lines.
-@table @env
+@table @kbd
@item break [@var{file}:][@var{function}|@var{line}]
Set a breakpoint at @var{function} or @var{line} (in @var{file}).
@@ -51884,7 +51884,7 @@ gdb man
in sequential order. The order makes a difference when the @option{-x}
option is used.
-@table @env
+@table @option
@item --help
@itemx -h
List all options, with brief explanations.
@@ -52297,7 +52297,7 @@ gdbserver man
In each of the modes you may specify these options:
-@table @env
+@table @option
@item --help
List all options, with brief explanations.
@@ -52428,7 +52428,7 @@ gcore man
@c man end
@c man begin OPTIONS gcore
-@table @env
+@table @option
@item -a
Dump all memory mappings. The actual effect of this option depends on
the Operating System. On @sc{gnu}/Linux, it will disable
@@ -52506,7 +52506,7 @@ gstack man
@c man end
@c man begin OPTIONS gstack
-@table @env
+@table @option
@item --help
@itemx -h
List all options, with brief explanations.
@@ -52594,12 +52594,12 @@ gdbinit man
@ref{Startup}.
@end ifclear
-@table @env
+@table @asis
@ifset SYSTEM_GDBINIT
-@item @value{SYSTEM_GDBINIT}
+@item @file{@value{SYSTEM_GDBINIT}}
@end ifset
@ifclear SYSTEM_GDBINIT
-@item (not enabled with @code{--with-system-gdbinit} during compilation)
+@item (not enabled with @option{--with-system-gdbinit} during compilation)
@end ifclear
System-wide initialization file. It is executed unless user specified
@value{GDBN} option @code{-nx} or @code{-n}.
@@ -52609,10 +52609,10 @@ gdbinit man
-- shell command @code{info -f gdb -n 'System-wide configuration'}.
@end ifset
@ifset SYSTEM_GDBINIT_DIR
-@item @value{SYSTEM_GDBINIT_DIR}
+@item @file{@value{SYSTEM_GDBINIT_DIR}}
@end ifset
@ifclear SYSTEM_GDBINIT_DIR
-@item (not enabled with @code{--with-system-gdbinit-dir} during compilation)
+@item (not enabled with @option{--with-system-gdbinit-dir} during compilation)
@end ifclear
System-wide initialization directory. All files in this directory are
executed on startup unless user specified @value{GDBN} option @code{-nx} or
@@ -52713,7 +52713,7 @@ gdb-add-index man
@c man end
@c man begin OPTIONS gdb-add-index
-@table @env
+@table @option
@item --dwarf-5
Add DWARF 5 sections instead of previous @code{.gdb_index} section.
diff --git a/gdb/doc/guile.texi b/gdb/doc/guile.texi
index 7bf773a649e..e7956c01ab6 100644
--- a/gdb/doc/guile.texi
+++ b/gdb/doc/guile.texi
@@ -55,7 +55,7 @@ Guile Commands
@value{GDBN} provides two commands for accessing the Guile interpreter:
-@table @code
+@table @kbd
@kindex guile-repl
@kindex gr
@item guile-repl
@@ -104,7 +104,7 @@ Guile Commands
It is also possible to execute a Guile script from the @value{GDBN}
interpreter:
-@table @code
+@table @kbd
@item source @file{script-name}
The script name must end with @samp{.scm} and @value{GDBN} must be configured
to recognize the script language based on filename extension using
@@ -3920,7 +3920,7 @@ Guile Auto-loading
Auto-loading can be enabled or disabled,
and the list of auto-loaded scripts can be printed.
-@table @code
+@table @kbd
@anchor{set auto-load guile-scripts}
@kindex set auto-load guile-scripts
@item set auto-load guile-scripts [on|off]
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 99d11d35aaf..c1eb39360c6 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -48,7 +48,7 @@ Python Commands
@value{GDBN} provides two commands for accessing the Python interpreter,
and one related setting:
-@table @code
+@table @kbd
@kindex python-interactive
@kindex pi
@item python-interactive @r{[}@var{command}@r{]}
@@ -150,7 +150,7 @@ Python Commands
It is also possible to execute a Python script from the @value{GDBN}
interpreter:
-@table @code
+@table @kbd
@item source @file{script-name}
The script name must end with @samp{.py} and @value{GDBN} must be configured
to recognize the script language based on filename extension using
@@ -159,7 +159,7 @@ Python Commands
The following commands are intended to help debug @value{GDBN} itself:
-@table @code
+@table @kbd
@kindex set debug py-breakpoint
@kindex show debug py-breakpoint
@item set debug py-breakpoint on@r{|}off
@@ -3174,7 +3174,7 @@ Unwinding Frames in Python
@value{GDBN} defines 3 commands to manage registered unwinders. These
are:
-@table @code
+@table @kbd
@item info unwinder @r{[} @var{locus} @r{[} @var{name-regexp} @r{]} @r{]}
Lists all registered unwinders. Arguments @var{locus} and
@var{name-regexp} are both optional and can be used to filter which
@@ -3949,7 +3949,7 @@ Events In Python
@table @code
@tindex gdb.InferiorCallPreEvent
-@item @code{gdb.InferiorCallPreEvent}
+@item gdb.InferiorCallPreEvent
Indicates that a function in the inferior is about to be called.
@defvar InferiorCallPreEvent.ptid
@@ -3961,7 +3961,7 @@ Events In Python
@end defvar
@tindex gdb.InferiorCallPostEvent
-@item @code{gdb.InferiorCallPostEvent}
+@item gdb.InferiorCallPostEvent
Indicates that a function in the inferior has just been called.
@defvar InferiorCallPostEvent.ptid
@@ -8949,7 +8949,7 @@ Missing Objfiles In Python
@value{GDBN} defines the following commands to manage registered
missing-objfile handlers:
-@table @code
+@table @kbd
@kindex info missing-objfile-handlers
@item info missing-objfile-handlers @r{[} @var{locus} @r{[} @var{name-regexp} @r{]} @r{]}
@@ -9099,7 +9099,7 @@ Python Auto-loading
Auto-loading can be enabled or disabled,
and the list of auto-loaded scripts can be printed.
-@table @code
+@table @kbd
@anchor{set auto-load python-scripts}
@kindex set auto-load python-scripts
@item set auto-load python-scripts [on|off]
--
2.55.0
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH 3/5] gdb/doc: consistent formatting for on|off on @item lines
2026-10-12 18:54 [PATCH 0/5] gdb/doc: a series of doc clean ups Andrew Burgess
2026-10-12 18:54 ` [PATCH 1/5] gdb/doc: use (@value{GDBP}) for the prompt in examples Andrew Burgess
2026-10-12 18:54 ` [PATCH 2/5] gdb/doc: fix some incorrect '@table @code' uses Andrew Burgess
@ 2026-10-12 18:54 ` Andrew Burgess
2026-10-13 11:33 ` Eli Zaretskii
2026-10-12 18:54 ` [PATCH 4/5] gdb/doc: make more use of @option{...} formatting Andrew Burgess
2026-10-12 18:54 ` [PATCH 5/5] gdb/doc: more @command and @kbd Andrew Burgess
4 siblings, 1 reply; 12+ messages in thread
From: Andrew Burgess @ 2026-10-12 18:54 UTC (permalink / raw)
To: gdb-patches; +Cc: Andrew Burgess
When a command takes 'on' or 'off' as an option then we have a bunch
of styles for how this is presented within a table's @item line:
@item set logging enabled [on|off]
@item -past-main [@code{on}|@code{off}]
@item set auto-load python-scripts @r{[}on@r{|}off@r{]}
Of these the last seems to be the style that is most often used for
new additions. I think it's the correct one because:
1. Use @r{...} to wrap the characters that are not part of the
command: [|], this ensures these characters are formatted as
normal text, not using the table style, which should be @kbd.
2. Wrapping 'on' and 'off' in @code{...} is clearly wrong, there
are not code. Using @samp{...} might work, but this isn't what
we currently do, and the 'on' and 'off' could be considered just
another part of the command, so using the table's default @kbd
style seems reasonable enough.
This commit updates some cases in the documentation which used the
first two styles to use the third style, this makes things more
consistent.
---
gdb/doc/gdb.texinfo | 78 ++++++++++++++++++++++-----------------------
gdb/doc/guile.texi | 4 +--
gdb/doc/python.texi | 4 +--
3 files changed, 43 insertions(+), 43 deletions(-)
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index fd298da584c..1468855c37f 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -1789,18 +1789,18 @@ Logging Output
@table @kbd
@kindex set logging enabled
-@item set logging enabled [on|off]
+@item set logging enabled @r{[}on@r{|}off@r{]}
Enable or disable logging.
@cindex logging file name
@item set logging file @var{file}
Change the name of the current logfile. The default logfile is @file{gdb.txt}.
-@item set logging overwrite [on|off]
+@item set logging overwrite @r{[}on@r{|}off@r{]}
By default, @value{GDBN} will append to the logfile. Set @code{overwrite} if
you want @code{set logging enabled on} to overwrite the logfile instead.
-@item set logging redirect [on|off]
+@item set logging redirect @r{[}on@r{|}off@r{]}
By default, @value{GDBN} output will go to both the terminal and the logfile.
Set @code{redirect} if you want output to go only to the log file.
-@item set logging debugredirect [on|off]
+@item set logging debugredirect @r{[}on@r{|}off@r{]}
By default, @value{GDBN} debug output will go to both the terminal and the logfile.
Set @code{debugredirect} if you want debug output to go only to the log file.
@kindex show logging
@@ -8788,11 +8788,11 @@ Backtrace
backtrace} and @code{set print} subcommands:
@table @code
-@item -past-main [@code{on}|@code{off}]
+@item -past-main @r{[}on@r{|}off@r{]}
Set whether backtraces should continue past @code{main}. Related setting:
@ref{set backtrace past-main}.
-@item -past-entry [@code{on}|@code{off}]
+@item -past-entry @r{[}on@r{|}off@r{]}
Set whether backtraces should continue past the entry point of a program.
Related setting: @ref{set backtrace past-entry}.
@@ -8804,7 +8804,7 @@ Backtrace
Set printing of non-scalar frame arguments.
Related setting: @ref{set print frame-arguments}.
-@item -raw-frame-arguments [@code{on}|@code{off}]
+@item -raw-frame-arguments @r{[}on@r{|}off@r{]}
Set whether to print frame arguments in raw form.
Related setting: @ref{set print raw-frame-arguments}.
@@ -9318,11 +9318,11 @@ Frame Apply
allow overriding relevant @code{set backtrace} settings:
@table @code
-@item -past-main [@code{on}|@code{off}]
+@item -past-main @r{[}on@r{|}off@r{]}
Whether backtraces should continue past @code{main}.
Related setting: @ref{set backtrace past-main}.
-@item -past-entry [@code{on}|@code{off}]
+@item -past-entry @r{[}on@r{|}off@r{]}
Whether backtraces should continue past the entry point of a program.
Related setting: @ref{set backtrace past-entry}.
@end table
@@ -10835,15 +10835,15 @@ Data
subcommands:
@table @code
-@item -address [@code{on}|@code{off}]
+@item -address @r{[}on@r{|}off@r{]}
Set printing of addresses.
Related setting: @ref{set print address}.
-@item -array [@code{on}|@code{off}]
+@item -array @r{[}on@r{|}off@r{]}
Pretty formatting of arrays.
Related setting: @ref{set print array}.
-@item -array-indexes [@code{on}|@code{off}]
+@item -array-indexes @r{[}on@r{|}off@r{]}
Set printing of array indexes.
Related setting: @ref{set print array-indexes}.
@@ -10864,27 +10864,27 @@ Data
Set the threshold after which nested structures are replaced with
ellipsis. Related setting: @ref{set print max-depth}.
-@item -nibbles [@code{on}|@code{off}]
+@item -nibbles @r{[}on@r{|}off@r{]}
Set whether to print binary values in groups of four bits, known
as ``nibbles''. @xref{set print nibbles}.
-@item -memory-tag-violations [@code{on}|@code{off}]
+@item -memory-tag-violations @r{[}on@r{|}off@r{]}
Set printing of additional information about memory tag violations.
@xref{set print memory-tag-violations}.
-@item -null-stop [@code{on}|@code{off}]
+@item -null-stop @r{[}on@r{|}off@r{]}
Set printing of char arrays to stop at first null char. Related
setting: @ref{set print null-stop}.
-@item -object [@code{on}|@code{off}]
+@item -object @r{[}on@r{|}off@r{]}
Set printing C@t{++} virtual function tables. Related setting:
@ref{set print object}.
-@item -pretty [@code{on}|@code{off}]
+@item -pretty @r{[}on@r{|}off@r{]}
Set pretty formatting of structures. Related setting: @ref{set print
pretty}.
-@item -raw-values [@code{on}|@code{off}]
+@item -raw-values @r{[}on@r{|}off@r{]}
Set whether to print values in raw form, bypassing any
pretty-printers for that value. Related setting: @ref{set print
raw-values}.
@@ -10894,19 +10894,19 @@ Data
all elements to be individually printed. Related setting: @ref{set
print repeats}.
-@item -static-members [@code{on}|@code{off}]
+@item -static-members @r{[}on@r{|}off@r{]}
Set printing C@t{++} static members. Related setting: @ref{set print
static-members}.
-@item -symbol [@code{on}|@code{off}]
+@item -symbol @r{[}on@r{|}off@r{]}
Set printing of symbol names when printing pointers. Related setting:
@ref{set print symbol}.
-@item -union [@code{on}|@code{off}]
+@item -union @r{[}on@r{|}off@r{]}
Set printing of unions interior to structures. Related setting:
@ref{set print union}.
-@item -vtbl [@code{on}|@code{off}]
+@item -vtbl @r{[}on@r{|}off@r{]}
Set printing of C++ virtual function tables. Related setting:
@ref{set print vtbl}.
@end table
@@ -14228,7 +14228,7 @@ Memory Region Attributes
@table @kbd
@kindex set mem inaccessible-by-default
-@item set mem inaccessible-by-default [on|off]
+@item set mem inaccessible-by-default @r{[}on@r{|}off@r{]}
If @code{on} is specified, make @value{GDBN} treat memory not
explicitly described by the memory ranges as non-existent and refuse accesses
to such memory. The checks are only performed if there's at least one
@@ -17198,7 +17198,7 @@ Automatically
setting:
@table @kbd
-@item set warn-language-frame-mismatch [on|off]
+@item set warn-language-frame-mismatch @r{[}on@r{|}off@r{]}
@kindex warn-language-frame-mismatch
Enable or disable the warning that is issued when the current language
is set to a value that does not match the current frame.
@@ -18390,7 +18390,7 @@ Special Fortran Commands
@cindex arrays slices (Fortran)
@kindex set fortran repack-array-slices
@kindex show fortran repack-array-slices
-@item set fortran repack-array-slices [on|off]
+@item set fortran repack-array-slices @r{[}on@r{|}off@r{]}
@item show fortran repack-array-slices
When taking a slice from an array, a Fortran compiler can choose to
either produce an array descriptor that describes the slice in place,
@@ -20021,7 +20021,7 @@ Ada Glitches
@table @kbd
@kindex maint ada set ignore-descriptive-types
-@item maintenance ada set ignore-descriptive-types [on|off]
+@item maintenance ada set ignore-descriptive-types @r{[}on@r{|}off@r{]}
Control whether the debugger should ignore descriptive types.
The default is not to ignore descriptives types (@code{off}).
@@ -20929,11 +20929,11 @@ Symbols
column indicates that a given address marks the point where a block's frame is
destroyed, making local variables hard or impossible to find.
-@kindex set always-read-ctf [on|off]
+@kindex set always-read-ctf @r{[}on@r{|}off@r{]}
@kindex show always-read-ctf
@cindex always-read-ctf
@cindex CTF info, when to read
-@item set always-read-ctf [on|off]
+@item set always-read-ctf @r{[}on@r{|}off@r{]}
@itemx show always-read-ctf
When off, CTF debug info is only read if DWARF debug info is not
@@ -20977,7 +20977,7 @@ Symbols
@kindex maint set ignore-prologue-end-flag
@cindex prologue-end
-@item maint set ignore-prologue-end-flag [on|off]
+@item maint set ignore-prologue-end-flag @r{[}on@r{|}off@r{]}
Enable or disable the use of the @samp{PROLOGUE-END} flag from the line-table.
When @samp{off} (the default), @value{GDBN} uses the @samp{PROLOGUE-END} flag
to place breakpoints past the end of a function prologue. When @samp{on},
@@ -29010,7 +29010,7 @@ Init File in the Current Directory
@table @kbd
@anchor{set auto-load local-gdbinit}
@kindex set auto-load local-gdbinit
-@item set auto-load local-gdbinit [on|off]
+@item set auto-load local-gdbinit @r{[}on@r{|}off@r{]}
Enable or disable the auto-loading of canned sequences of commands
(@pxref{Sequences}) found in init file in the current directory.
@@ -29049,7 +29049,7 @@ libthread_db.so.1 file
@table @kbd
@anchor{set auto-load libthread-db}
@kindex set auto-load libthread-db
-@item set auto-load libthread-db [on|off]
+@item set auto-load libthread-db @r{[}on@r{|}off@r{]}
Enable or disable the auto-loading of inferior specific thread debugging library.
@anchor{show auto-load libthread-db}
@@ -29217,7 +29217,7 @@ Auto-loading verbose mode
@table @kbd
@anchor{set debug auto-load}
@kindex set debug auto-load
-@item set debug auto-load [on|off]
+@item set debug auto-load @r{[}on@r{|}off@r{]}
Set whether to print the filenames attempted to be auto-loaded.
@anchor{show debug auto-load}
@@ -30524,7 +30524,7 @@ Auto-loading sequences
@table @kbd
@anchor{set auto-load gdb-scripts}
@kindex set auto-load gdb-scripts
-@item set auto-load gdb-scripts [on|off]
+@item set auto-load gdb-scripts @r{[}on@r{|}off@r{]}
Enable or disable the auto-loading of canned sequences of commands scripts.
@anchor{show auto-load gdb-scripts}
@@ -42311,7 +42311,7 @@ Maintenance Commands
@kindex maint set catch-demangler-crashes
@kindex maint show catch-demangler-crashes
@cindex demangler crashes
-@item maint set catch-demangler-crashes [on|off]
+@item maint set catch-demangler-crashes @r{[}on@r{|}off@r{]}
@itemx maint show catch-demangler-crashes
Control whether @value{GDBN} should attempt to catch crashes in the
symbol name demangler. The default is to attempt to catch crashes.
@@ -43142,7 +43142,7 @@ Maintenance Commands
This is useful in debugging performance problems.
@table @kbd
-@item maint set per-command space [on|off]
+@item maint set per-command space @r{[}on@r{|}off@r{]}
@itemx maint show per-command space
Enable or disable the printing of the memory used by GDB for each command.
If enabled, @value{GDBN} will display how much memory each command
@@ -43150,7 +43150,7 @@ Maintenance Commands
This can also be requested by invoking @value{GDBN} with the
@option{--statistics} command-line switch (@pxref{Mode Options}).
-@item maint set per-command time [on|off]
+@item maint set per-command time @r{[}on@r{|}off@r{]}
@itemx maint show per-command time
Enable or disable the printing of the execution time of @value{GDBN}
for each command.
@@ -43166,7 +43166,7 @@ Maintenance Commands
This can also be requested by invoking @value{GDBN} with the
@option{--statistics} command-line switch (@pxref{Mode Options}).
-@item maint set per-command symtab [on|off]
+@item maint set per-command symtab @r{[}on@r{|}off@r{]}
@itemx maint show per-command symtab
Enable or disable the printing of basic symbol table statistics
for each command.
@@ -43184,7 +43184,7 @@ Maintenance Commands
@kindex maint set check-libthread-db
@kindex maint show check-libthread-db
-@item maint set check-libthread-db [on|off]
+@item maint set check-libthread-db @r{[}on@r{|}off@r{]}
@itemx maint show check-libthread-db
Control whether @value{GDBN} should run integrity checks on inferior
specific thread debugging libraries as they are loaded. The default
@@ -43318,7 +43318,7 @@ Maintenance Commands
@kindex maint set backtrace-on-fatal-signal
@kindex maint show backtrace-on-fatal-signal
-@item maint set backtrace-on-fatal-signal [on|off]
+@item maint set backtrace-on-fatal-signal @r{[}on@r{|}off@r{]}
@itemx maint show backtrace-on-fatal-signal
When this setting is @code{on}, if @value{GDBN} itself terminates with
a fatal signal (e.g.@: SIGSEGV), then a limited backtrace will be
diff --git a/gdb/doc/guile.texi b/gdb/doc/guile.texi
index e7956c01ab6..91b2ad061d3 100644
--- a/gdb/doc/guile.texi
+++ b/gdb/doc/guile.texi
@@ -3923,7 +3923,7 @@ Guile Auto-loading
@table @kbd
@anchor{set auto-load guile-scripts}
@kindex set auto-load guile-scripts
-@item set auto-load guile-scripts [on|off]
+@item set auto-load guile-scripts @r{[}on@r{|}off@r{]}
Enable or disable the auto-loading of Guile scripts.
@anchor{show auto-load guile-scripts}
@@ -3934,7 +3934,7 @@ Guile Auto-loading
@anchor{info auto-load guile-scripts}
@kindex info auto-load guile-scripts
@cindex print list of auto-loaded Guile scripts
-@item info auto-load guile-scripts [@var{regexp}]
+@item info auto-load guile-scripts @r{[}@var{regexp}@r{]}
Print the list of all Guile scripts that @value{GDBN} auto-loaded.
Also printed is the list of Guile scripts that were mentioned in
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index c1eb39360c6..02c407bb887 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -9102,7 +9102,7 @@ Python Auto-loading
@table @kbd
@anchor{set auto-load python-scripts}
@kindex set auto-load python-scripts
-@item set auto-load python-scripts [on|off]
+@item set auto-load python-scripts @r{[}on@r{|}off@r{]}
Enable or disable the auto-loading of Python scripts.
@anchor{show auto-load python-scripts}
@@ -9113,7 +9113,7 @@ Python Auto-loading
@anchor{info auto-load python-scripts}
@kindex info auto-load python-scripts
@cindex print list of auto-loaded Python scripts
-@item info auto-load python-scripts [@var{regexp}]
+@item info auto-load python-scripts @r{[}@var{regexp}@r{]}
Print the list of all Python scripts that @value{GDBN} auto-loaded.
Also printed is the list of Python scripts that were mentioned in
--
2.55.0
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH 4/5] gdb/doc: make more use of @option{...} formatting
2026-10-12 18:54 [PATCH 0/5] gdb/doc: a series of doc clean ups Andrew Burgess
` (2 preceding siblings ...)
2026-10-12 18:54 ` [PATCH 3/5] gdb/doc: consistent formatting for on|off on @item lines Andrew Burgess
@ 2026-10-12 18:54 ` Andrew Burgess
2026-10-13 12:00 ` Eli Zaretskii
2026-10-12 18:54 ` [PATCH 5/5] gdb/doc: more @command and @kbd Andrew Burgess
4 siblings, 1 reply; 12+ messages in thread
From: Andrew Burgess @ 2026-10-12 18:54 UTC (permalink / raw)
To: gdb-patches; +Cc: Andrew Burgess
I noticed that there are lots of places in our docs where command line
options, either for GDB or for other programs (e.g. compilers) are
formatted as either @code or @samp.
In this commit I made use of regexp replacement looking for anything
that matched: "@(code|samp)\{-[^}]+\}" and if I was reasonably certain
that it was a command line option I switched to use @option{...}. If
I had any doubt then I left things as they were.
I'm sure that there are places that I've missed, but hopefully this
makes the docs a little better.
---
gdb/doc/gdb.texinfo | 350 ++++++++++++++++++++++----------------------
gdb/doc/guile.texi | 4 +-
2 files changed, 177 insertions(+), 177 deletions(-)
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 1468855c37f..e23ca31c8fc 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -883,7 +883,7 @@ Invoking GDB
@end smallexample
You can, instead, specify a process ID as a second argument or use option
-@code{-p}, if you want to debug a running process:
+@option{-p}, if you want to debug a running process:
@smallexample
@value{GDBP} @var{program} 1234
@@ -901,20 +901,20 @@ Invoking GDB
will warn you if it is unable to attach or to read core dumps.
You can optionally have @code{@value{GDBP}} pass any arguments after
-the executable file to the inferior using @code{--args} or
-@code{--no-escape-args}. These options stop option processing.
+the executable file to the inferior using @option{--args} or
+@option{--no-escape-args}. These options stop option processing.
@smallexample
@value{GDBP} --args gcc -O2 -c foo.c
@end smallexample
This will cause @code{@value{GDBP}} to debug @code{gcc}, and to set
@code{gcc}'s command-line arguments (@pxref{Arguments}) to @samp{-O2
--c foo.c}. For the differences between @code{--args} and
-@code{--no-escape-args}, see @ref{--args and --no-escape-args options,
-,@code{--args} and @code{--no-escape-args}}.
+-c foo.c}. For the differences between @option{--args} and
+@option{--no-escape-args}, see @ref{--args and --no-escape-args options,
+,@option{--args} and @option{--no-escape-args}}.
You can run @code{@value{GDBP}} without printing the front material, which describes
-@value{GDBN}'s non-warranty, by specifying @code{--silent}
-(or @code{-q}/@code{--quiet}):
+@value{GDBN}'s non-warranty, by specifying @option{--silent}
+(or @option{-q}/@option{--quiet}):
@smallexample
@value{GDBP} --silent
@@ -937,7 +937,7 @@ Invoking GDB
All options and command line arguments you give are processed
in sequential order. The order makes a difference when the
-@samp{-x} option is used.
+@option{-x} option is used.
@menu
@@ -952,12 +952,12 @@ File Options
When @value{GDBN} starts, it reads any arguments other than options as
specifying an executable file and core file (or process ID). This is
-the same as if the arguments were specified by the @samp{-se} and
-@samp{-c} (or @samp{-p}) options respectively. (@value{GDBN} reads the
+the same as if the arguments were specified by the @option{-se} and
+@option{-c} (or @option{-p}) options respectively. (@value{GDBN} reads the
first argument that does not have an associated option flag as
-equivalent to the @samp{-se} option followed by that argument; and the
+equivalent to the @option{-se} option followed by that argument; and the
second argument that does not have an associated option flag, if any, as
-equivalent to the @samp{-c}/@samp{-p} option followed by that argument.)
+equivalent to the @option{-c}/@option{-p} option followed by that argument.)
If the second argument begins with a decimal digit, @value{GDBN} will
first attempt to attach to it as a process, and if that fails, attempt
to open it as a corefile. If you have a corefile whose name begins with
@@ -968,7 +968,7 @@ File Options
such as for most embedded targets, then it will complain about a second
argument and ignore it.
-For the @samp{-s}, @samp{-e}, and @samp{-se} options, and their long
+For the @option{-s}, @option{-e}, and @option{-se} options, and their long
form equivalents, the method used to search the file system for the
symbol and/or executable file is the same as that used by the
@code{file} command. @xref{Files, ,file}.
@@ -986,50 +986,50 @@ File Options
@table @option
@item -symbols @var{file}
@itemx -s @var{file}
-@cindex @code{--symbols}
-@cindex @code{-s}
+@cindex @option{--symbols}
+@cindex @option{-s}
Read symbol table from file @var{file}.
@item -exec @var{file}
@itemx -e @var{file}
-@cindex @code{--exec}
-@cindex @code{-e}
+@cindex @option{--exec}
+@cindex @option{-e}
Use file @var{file} as the executable file to execute when appropriate,
and for examining pure data in conjunction with a core dump.
@item -se @var{file}
-@cindex @code{--se}
+@cindex @option{--se}
Read symbol table from file @var{file} and use it as the executable
file.
@item -core @var{file}
@itemx -c @var{file}
-@cindex @code{--core}
-@cindex @code{-c}
+@cindex @option{--core}
+@cindex @option{-c}
Use file @var{file} as a core dump to examine.
@item -pid @var{number}
@itemx -p @var{number}
-@cindex @code{--pid}
-@cindex @code{-p}
+@cindex @option{--pid}
+@cindex @option{-p}
Connect to process ID @var{number}, as with the @code{attach} command.
@item -command @var{file}
@itemx -x @var{file}
-@cindex @code{--command}
-@cindex @code{-x}
+@cindex @option{--command}
+@cindex @option{-x}
Execute commands from file @var{file}. The contents of this file is
evaluated exactly as the @code{source} command would.
@xref{Command Files,, Command files}.
@item -eval-command @var{command}
@itemx -ex @var{command}
-@cindex @code{--eval-command}
-@cindex @code{-ex}
+@cindex @option{--eval-command}
+@cindex @option{-ex}
Execute a single @value{GDBN} command.
This option may be used multiple times to call multiple commands. It may
-also be interleaved with @samp{-command} as required.
+also be interleaved with @option{-command} as required.
@smallexample
@value{GDBP} -ex 'target sim' -ex 'load' \
@@ -1038,51 +1038,51 @@ File Options
@item -init-command @var{file}
@itemx -ix @var{file}
-@cindex @code{--init-command}
-@cindex @code{-ix}
+@cindex @option{--init-command}
+@cindex @option{-ix}
Execute commands from file @var{file} before loading the inferior (but
after loading gdbinit files).
@xref{Startup}.
@item -init-eval-command @var{command}
@itemx -iex @var{command}
-@cindex @code{--init-eval-command}
-@cindex @code{-iex}
+@cindex @option{--init-eval-command}
+@cindex @option{-iex}
Execute a single @value{GDBN} command before loading the inferior (but
after loading gdbinit files).
@xref{Startup}.
@item -early-init-command @var{file}
@itemx -eix @var{file}
-@cindex @code{--early-init-command}
-@cindex @code{-eix}
+@cindex @option{--early-init-command}
+@cindex @option{-eix}
Execute commands from @var{file} very early in the initialization
process, before any output is produced. @xref{Startup}.
@item -early-init-eval-command @var{command}
@itemx -eiex @var{command}
-@cindex @code{--early-init-eval-command}
-@cindex @code{-eiex}
+@cindex @option{--early-init-eval-command}
+@cindex @option{-eiex}
Execute a single @value{GDBN} command very early in the initialization
process, before any output is produced.
@item -directory @var{directory}
@itemx -d @var{directory}
-@cindex @code{--directory}
-@cindex @code{-d}
+@cindex @option{--directory}
+@cindex @option{-d}
Add @var{directory} to the path to search for source and script files.
@item -r
@itemx -readnow
-@cindex @code{--readnow}
-@cindex @code{-r}
+@cindex @option{--readnow}
+@cindex @option{-r}
Read each symbol file's entire symbol table immediately, rather than
the default, which is to read it incrementally as it is needed.
This makes startup slower, but makes future operations faster.
@item --readnever
@anchor{--readnever}
-@cindex @code{--readnever}, command-line option
+@cindex @option{--readnever}, command-line option
Do not read each symbol file's symbolic debug information. This makes
startup faster but at the expense of not being able to perform
symbolic debugging. DWARF unwind information is also not read,
@@ -1102,14 +1102,14 @@ Mode Options
@anchor{-nx}
@item -nx
@itemx -n
-@cindex @code{--nx}
-@cindex @code{-n}
+@cindex @option{--nx}
+@cindex @option{-n}
Do not execute commands found in any initialization files
(@pxref{Initialization Files}).
@anchor{-nh}
@item -nh
-@cindex @code{--nh}
+@cindex @option{--nh}
Do not execute commands found in any home directory initialization
file (@pxref{Initialization Files,,Home directory initialization
file}). The system wide and current directory initialization files
@@ -1118,9 +1118,9 @@ Mode Options
@item -quiet
@itemx -silent
@itemx -q
-@cindex @code{--quiet}
-@cindex @code{--silent}
-@cindex @code{-q}
+@cindex @option{--quiet}
+@cindex @option{--silent}
+@cindex @option{-q}
``Quiet''. Do not print the introductory and copyright messages. These
messages are also suppressed in batch mode.
@@ -1133,10 +1133,10 @@ Mode Options
Files}) to have future @value{GDBN} sessions startup quietly.
@item -batch
-@cindex @code{--batch}
+@cindex @option{--batch}
Run in batch mode. Exit with status @code{0} after processing all the
-command files specified with @samp{-x} (and all commands from
-initialization files, if not inhibited with @samp{-n}). Exit with
+command files specified with @option{-x} (and all commands from
+initialization files, if not inhibited with @option{-n}). Exit with
nonzero status if an error occurs in executing the @value{GDBN} commands
in the command files. Batch mode also disables pagination, sets unlimited
terminal width and height @pxref{Screen Size}, and acts as if @kbd{set confirm
@@ -1156,10 +1156,10 @@ Mode Options
mode.
@item -batch-silent
-@cindex @code{--batch-silent}
-Run in batch mode exactly like @samp{-batch}, but totally silently. All
+@cindex @option{--batch-silent}
+Run in batch mode exactly like @option{-batch}, but totally silently. All
@value{GDBN} output to @code{stdout} is prevented (@code{stderr} is
-unaffected). This is much quieter than @samp{-silent} and would be useless
+unaffected). This is much quieter than @option{-silent} and would be useless
for an interactive session.
This is particularly useful when using targets that give @samp{Loading section}
@@ -1169,7 +1169,7 @@ Mode Options
writing directly to @code{stdout}, will also be made silent.
@item -return-child-result
-@cindex @code{--return-child-result}
+@cindex @option{--return-child-result}
The return code from @value{GDBN} will be the return code from the child
process (the process being debugged), with the following exceptions:
@@ -1177,7 +1177,7 @@ Mode Options
@item
@value{GDBN} exits abnormally. E.g., due to an incorrect argument or an
internal error. In this case the exit code is the same as it would have been
-without @samp{-return-child-result}.
+without @option{-return-child-result}.
@item
The user quits with an explicit value. E.g., @samp{quit 1}.
@item
@@ -1185,40 +1185,40 @@ Mode Options
the exit code will be -1.
@end itemize
-This option is useful in conjunction with @samp{-batch} or @samp{-batch-silent},
+This option is useful in conjunction with @option{-batch} or @option{-batch-silent},
when @value{GDBN} is being used as a remote program loader or simulator
interface.
@item -nowindows
@itemx -nw
-@cindex @code{--nowindows}
-@cindex @code{-nw}
+@cindex @option{--nowindows}
+@cindex @option{-nw}
``No windows''. If @value{GDBN} comes with a graphical user interface
(GUI) built in, then this option tells @value{GDBN} to only use the command-line
interface. If no GUI is available, this option has no effect.
@item -windows
@itemx -w
-@cindex @code{--windows}
-@cindex @code{-w}
+@cindex @option{--windows}
+@cindex @option{-w}
If @value{GDBN} includes a GUI, then this option requires it to be
used if possible.
@item -cd @var{directory}
-@cindex @code{--cd}
+@cindex @option{--cd}
Run @value{GDBN} using @var{directory} as its working directory,
instead of the current directory.
@item -data-directory @var{directory}
@itemx -D @var{directory}
-@cindex @code{--data-directory}
-@cindex @code{-D}
+@cindex @option{--data-directory}
+@cindex @option{-D}
Run @value{GDBN} using @var{directory} as its data directory.
The data directory is where @value{GDBN} searches for its
auxiliary files. @xref{Data Files}.
@item -binary-output
-@cindex @code{--binary-output}
+@cindex @option{--binary-output}
Instructs @value{GDBN} to set the translation mode of its
@code{stdout}/@code{stderr} to binary. MS-Windows only. Useful for
@@ -1230,8 +1230,8 @@ Mode Options
@item -fullname
@itemx -f
-@cindex @code{--fullname}
-@cindex @code{-f}
+@cindex @option{--fullname}
+@cindex @option{-f}
@sc{gnu} Emacs sets this option when it runs @value{GDBN} as a
subprocess. It tells @value{GDBN} to output the full file name and line
number in a standard, recognizable fashion each time a stack frame is
@@ -1243,7 +1243,7 @@ Mode Options
frame.
@item -annotate @var{level}
-@cindex @code{--annotate}
+@cindex @option{--annotate}
This option sets the @dfn{annotation level} inside @value{GDBN}. Its
effect is identical to using @samp{set annotate @var{level}}
(@pxref{Annotations}). The annotation @var{level} controls how much
@@ -1258,12 +1258,12 @@ Mode Options
@anchor{--args and --no-escape-args options}
@item --args
-@cindex @code{--args}
+@cindex @option{--args}
Change interpretation of command line so that arguments following the
executable file are passed as command line arguments to the inferior.
This option stops option processing.
-Arguments supplied using @code{--args} will have backslashes applied
+Arguments supplied using @option{--args} will have backslashes applied
to escape any special shell characters. This ensures that when the
inferior starts it is passed arguments exactly as @value{GDBN}
receives them.
@@ -1297,15 +1297,15 @@ Mode Options
@noindent
If this quoting behaviour does not meet your needs, then you could use
-@code{--no-escape-args} instead, which is described below.
+@option{--no-escape-args} instead, which is described below.
@item --no-escape-args
-@cindex @code{--no-escape-args}
+@cindex @option{--no-escape-args}
Change interpretation of command line so that arguments following the
executable file are passed as command line arguments to the inferior.
This option stops option processing.
-Unlike @code{--args}, arguments after the executable name will not
+Unlike @option{--args}, arguments after the executable name will not
have any escaping applied to them. As a result, any special shell
characters that are not expanded by the shell that invokes
@value{GDBN} will be expanded by the shell that @value{GDBN} uses to
@@ -1319,26 +1319,26 @@ Mode Options
@item -baud @var{bps}
@itemx -b @var{bps}
-@cindex @code{--baud}
-@cindex @code{-b}
+@cindex @option{--baud}
+@cindex @option{-b}
Set the line speed (baud rate or bits per second) of any serial
interface used by @value{GDBN} for remote debugging.
@item -l @var{timeout}
-@cindex @code{-l}
+@cindex @option{-l}
Set the timeout (in seconds) of any communication used by @value{GDBN}
for remote debugging.
@item -tty @var{device}
@itemx -t @var{device}
-@cindex @code{--tty}
-@cindex @code{-t}
+@cindex @option{--tty}
+@cindex @option{-t}
Run using @var{device} for your program's standard input and output.
@c FIXME: kingdon thinks there is more to -tty. Investigate.
@c resolve the situation of these eventually
@item -tui
-@cindex @code{--tui}
+@cindex @option{--tui}
Activate the @dfn{Text User Interface} when starting. The Text User
Interface manages several text windows on the terminal, showing
source, assembly, registers and @value{GDBN} command outputs
@@ -1347,13 +1347,13 @@ Mode Options
Using @value{GDBN} under @sc{gnu} Emacs}).
@item -interpreter @var{interp}
-@cindex @code{--interpreter}
+@cindex @option{--interpreter}
Use the interpreter @var{interp} for interface with the controlling
program or device. This option is meant to be set by programs which
communicate with @value{GDBN} using it as a back end.
@xref{Interpreters, , Command Interpreters}.
-@samp{--interpreter=mi} (or @samp{--interpreter=mi3}) causes
+@option{--interpreter=mi} (or @option{--interpreter=mi3}) causes
@value{GDBN} to use the @dfn{@sc{gdb/mi} interface} version 3 (@pxref{GDB/MI, ,
The @sc{gdb/mi} Interface}) included since @value{GDBN} version 9.1. @sc{gdb/mi}
version 2 (@code{mi2}), included in @value{GDBN} 6.0 and version 1 (@code{mi1}),
@@ -1361,23 +1361,23 @@ Mode Options
interfaces are no longer supported.
@item -write
-@cindex @code{--write}
+@cindex @option{--write}
Open the executable and core files for both reading and writing. This
is equivalent to the @samp{set write on} command inside @value{GDBN}
(@pxref{Patching}).
@item -statistics
-@cindex @code{--statistics}
+@cindex @option{--statistics}
This option causes @value{GDBN} to print statistics about time and
memory usage after it completes each command and returns to the prompt.
@item -version
-@cindex @code{--version}
+@cindex @option{--version}
This option causes @value{GDBN} to print its version number and
no-warranty blurb, and exit.
@item -configuration
-@cindex @code{--configuration}
+@cindex @option{--configuration}
This option causes @value{GDBN} to print details about its build-time
configuration parameters, and then exit. These details can be
important when reporting @value{GDBN} bugs (@pxref{GDB Bugs}).
@@ -1403,10 +1403,10 @@ Startup
details.
@item
-Executes commands and command files specified by the @samp{-eiex} and
-@samp{-eix} command line options in their specified order. Only a
-restricted set of commands can be used with @samp{-eiex} and
-@samp{eix}, see @ref{Initialization Files}, for details.
+Executes commands and command files specified by the @option{-eiex} and
+@option{-eix} command line options in their specified order. Only a
+restricted set of commands can be used with @option{-eiex} and
+@option{-eix}, see @ref{Initialization Files}, for details.
@item
Sets up the command interpreter as specified by the command line
@@ -1424,9 +1424,9 @@ Startup
@anchor{Option -init-eval-command}
@item
-Executes commands and command files specified by the @samp{-iex} and
-@samp{-ix} options in their specified order. Usually you should use the
-@samp{-ex} and @samp{-x} options instead, but this way you can apply
+Executes commands and command files specified by the @option{-iex} and
+@option{-ix} options in their specified order. Usually you should use the
+@option{-ex} and @option{-x} options instead, but this way you can apply
settings before @value{GDBN} init files get executed and before inferior
gets loaded.
@@ -1457,12 +1457,12 @@ Startup
$ gdb -iex "set auto-load python-scripts off" myprogram
@end smallexample
-Option @samp{-ex} does not work because the auto-loading is then turned
+Option @option{-ex} does not work because the auto-loading is then turned
off too late.
@item
-Executes commands and command files specified by the @samp{-ex} and
-@samp{-x} options in their specified order. @xref{Command Files}, for
+Executes commands and command files specified by the @option{-ex} and
+@option{-x} options in their specified order. @xref{Command Files}, for
more details about @value{GDBN} command files.
@item
@@ -1497,10 +1497,10 @@ Initialization Files
documented as such throughout this manual. Any command that is not
documented as being suitable for an early initialization file should
instead be placed into a general initialization file. Command files
-passed to @code{--early-init-command} or @code{-eix} are also early
+passed to @option{--early-init-command} or @option{-eix} are also early
initialization files, with the same command restrictions. Only
commands that can appear in an early initialization file should be
-passed to @code{--early-init-eval-command} or @code{-eiex}.
+passed to @option{--early-init-eval-command} or @option{-eiex}.
@cindex general initialization
In contrast, the @dfn{general initialization} files are processed
@@ -1558,7 +1558,7 @@ Initialization Files
@end itemize
It is possible to prevent the home directory early initialization file
-from being loaded using the @samp{-nx} or @samp{-nh} command line
+from being loaded using the @option{-nx} or @option{-nh} command line
options, @pxref{Mode Options,,Choosing Modes}.
@anchor{System Wide Init Files}
@@ -1571,13 +1571,13 @@ Initialization Files
@item system.gdbinit
This is a single system-wide initialization file. Its location is
-specified with the @code{--with-system-gdbinit} configure option
+specified with the @option{--with-system-gdbinit} configure option
(@pxref{System-wide configuration}). It is loaded first when
@value{GDBN} starts, before command line options have been processed.
@item system.gdbinit.d
This is the system-wide initialization directory. Its location is
-specified with the @code{--with-system-gdbinit-dir} configure option
+specified with the @option{--with-system-gdbinit-dir} configure option
(@pxref{System-wide configuration}). Files in this directory are
loaded in alphabetical order immediately after @file{system.gdbinit}
(if enabled) when @value{GDBN} starts, before command line options
@@ -1590,7 +1590,7 @@ Initialization Files
@end table
It is possible to prevent the system wide initialization files from
-being loaded using the @samp{-nx} command line option, @pxref{Mode
+being loaded using the @option{-nx} command line option, @pxref{Mode
Options,,Choosing Modes}.
@anchor{Home Directory Init File}
@@ -1622,7 +1622,7 @@ Initialization Files
@end table
It is possible to prevent the home directory initialization file from
-being loaded using the @samp{-nx} or @samp{-nh} command line options,
+being loaded using the @option{-nx} or @option{-nh} command line options,
@pxref{Mode Options,,Choosing Modes}.
The DJGPP port of @value{GDBN} uses the name @file{gdb.ini} instead of
@@ -1637,8 +1637,8 @@ Initialization Files
@value{GDBN} will check the current directory for a file called
@file{.gdbinit}. It is loaded last, after command line options
-other than @samp{-x} and @samp{-ex} have been processed. The command
-line options @samp{-x} and @samp{-ex} are processed last, after
+other than @option{-x} and @option{-ex} have been processed. The command
+line options @option{-x} and @option{-ex} are processed last, after
@file{.gdbinit} has been loaded, @pxref{File Options,,Choosing
Files}.
@@ -1647,7 +1647,7 @@ Initialization Files
time.
It is possible to prevent the local directory initialization file from
-being loaded using the @samp{-nx} command line option, @pxref{Mode
+being loaded using the @option{-nx} command line option, @pxref{Mode
Options,,Choosing Modes}.
@node Quitting GDB
@@ -2616,23 +2616,23 @@ Compilation
variable or function and the correspondence between source line numbers
and addresses in the executable code.
-To request debugging information, specify the @samp{-g} option when you run
+To request debugging information, specify the @option{-g} option when you run
the compiler.
Programs that are to be shipped to your customers are compiled with
-optimizations, using the @samp{-O} compiler option. However, some
-compilers are unable to handle the @samp{-g} and @samp{-O} options
+optimizations, using the @option{-O} compiler option. However, some
+compilers are unable to handle the @option{-g} and @option{-O} options
together. Using those compilers, you cannot generate optimized
executables containing debugging information.
-@value{NGCC}, the @sc{gnu} C/C@t{++} compiler, supports @samp{-g} with or
-without @samp{-O}, making it possible to debug optimized code. We
-recommend that you @emph{always} use @samp{-g} whenever you compile a
+@value{NGCC}, the @sc{gnu} C/C@t{++} compiler, supports @option{-g} with or
+without @option{-O}, making it possible to debug optimized code. We
+recommend that you @emph{always} use @option{-g} whenever you compile a
program. You may think your program is correct, but there is no sense
in pushing your luck. For more information, see @ref{Optimized Code}.
Older versions of the @sc{gnu} C compiler permitted a variant option
-@w{@samp{-gg}} for debugging information. @value{GDBN} no longer supports this
+@option{-gg} for debugging information. @value{GDBN} no longer supports this
format; if your @sc{gnu} C compiler has this option, do not use it.
@value{GDBN} knows about preprocessor macros and can show you their
@@ -5827,7 +5827,7 @@ Set Catchpoints
(@value{GDBP})
@end smallexample
-If you configure @value{GDBN} using the @samp{--without-expat} option,
+If you configure @value{GDBN} using the @option{--without-expat} option,
it will not be able to display syscall names. Also, if your
architecture does not have an XML file describing its system calls,
you will not be able to see the syscall names. It is important to
@@ -8713,7 +8713,7 @@ Frames
Some compilers provide a way to compile functions so that they operate
without stack frames. (For example, the @value{NGCC} option
@smallexample
-@samp{-fomit-frame-pointer}
+@option{-fomit-frame-pointer}
@end smallexample
generates functions without a frame.)
This is occasionally done with heavily used library functions to save
@@ -10241,7 +10241,7 @@ Source Path
To add other directories, use the @code{directory} command.
The search path is used to find both program source files and @value{GDBN}
-script files (read using the @samp{-command} option and @samp{source} command).
+script files (read using the @option{-command} option and @samp{source} command).
@cindex substitution rules, for source search path
@cindex source directories, substitution rules
@@ -10292,13 +10292,13 @@ Source Path
located at the original location, a substitution rule is the only
method available to point @value{GDBN} at the new location.
-@cindex @samp{--with-relocated-sources}
+@cindex @option{--with-relocated-sources}
@cindex default source path substitution
You can configure a default source path substitution rule by
configuring @value{GDBN} with the
-@samp{--with-relocated-sources=@var{dir}} option. The @var{dir}
+@option{--with-relocated-sources=@var{dir}} option. The @var{dir}
should be the name of a directory under @value{GDBN}'s configured
-prefix (set with @samp{--prefix} or @samp{--exec-prefix}), and
+prefix (set with @option{--prefix} or @option{--exec-prefix}), and
directory names in debug information under @var{dir} will be adjusted
automatically if the installed @value{GDBN} is moved to a new
location. This is useful if @value{GDBN}, libraries or executables
@@ -10607,7 +10607,7 @@ Machine Code
Here is an example for AMD x86-64 showing the difference between
@code{/m} output and @code{/s} output.
This example has one inline function defined in a header file,
-and the code is compiled with @samp{-O2} optimization.
+and the code is compiled with @option{-O2} optimization.
Note how the @code{/m} output is missing the disassembly of
several instructions that are present in the @code{/s} output.
@@ -10725,7 +10725,7 @@ Machine Code
@item set disassembler-options @var{option1}[,@var{option2}@dots{}]
This command controls the passing of target specific information to
the disassembler. For a list of valid options, please refer to the
-@code{-M}/@code{--disassembler-options} section of the @samp{objdump}
+@option{-M}/@option{--disassembler-options} section of the @samp{objdump}
manual and/or the output of @kbd{objdump --help}
(@pxref{objdump,,objdump,binutils,The GNU Binary Utilities}).
The default value is the empty string.
@@ -10970,7 +10970,7 @@ Data
@kindex explore
Another way of examining values of expressions and type information is
through the Python extension command @code{explore} (available only if
-the @value{GDBN} build is configured with @code{--with-python}). It
+the @value{GDBN} build is configured with @option{--with-python}). It
offers an interactive way to start at the highest level (or, the most
abstract level) of the data type of an expression (or, the data type
itself) and explore all the way down to leaf scalar values/fields
@@ -11498,8 +11498,8 @@ Variables
Strings are identified as arrays of @code{char} values without specified
signedness. Arrays of either @code{signed char} or @code{unsigned char} get
-printed as arrays of 1 byte sized integers. @code{-fsigned-char} or
-@code{-funsigned-char} @value{NGCC} options have no effect as @value{GDBN}
+printed as arrays of 1 byte sized integers. @option{-fsigned-char} or
+@option{-funsigned-char} @value{NGCC} options have no effect as @value{GDBN}
defines literal string type @code{"char"} as @code{char} without a sign.
For program code
@@ -14884,8 +14884,8 @@ Optimized Code
variable---because the compiler optimizes it out of existence.
Some things do not work as well with @samp{-g -O} as with just
-@samp{-g}, particularly on machines with instruction scheduling. If in
-doubt, recompile with @samp{-g} alone, and if this fixes the problem,
+@option{-g}, particularly on machines with instruction scheduling. If in
+doubt, recompile with @option{-g} alone, and if this fixes the problem,
please report it to us as a bug (including a test case!).
@xref{Variables}, for more information about debugging optimized code.
@@ -21786,17 +21786,17 @@ Compiling and Injecting Code
@table @asis
@item target architecture and OS options (@code{gdbarch})
These options depend on target processor type and target operating
-system, usually they specify at least 32-bit (@code{-m32}) or 64-bit
-(@code{-m64}) compilation option.
+system, usually they specify at least 32-bit (@option{-m32}) or 64-bit
+(@option{-m64}) compilation option.
@item compilation options recorded in the target
@value{NGCC} (since version 4.7) stores the options used for compilation
into @code{DW_AT_producer} part of DWARF debugging information according
-to the @value{NGCC} option @code{-grecord-gcc-switches}. One has to
-explicitly specify @code{-g} during inferior compilation otherwise
+to the @value{NGCC} option @option{-grecord-gcc-switches}. One has to
+explicitly specify @option{-g} during inferior compilation otherwise
@value{NGCC} produces no DWARF. This feature is only relevant for
-platforms where @code{-g} produces DWARF by default, otherwise one may
-try to enforce DWARF by using @code{-gdwarf-4}.
+platforms where @option{-g} produces DWARF by default, otherwise one may
+try to enforce DWARF by using @option{-gdwarf-4}.
@item compilation options set by @code{set compile-args}
@end table
@@ -22651,11 +22651,11 @@ Files
sysroot}.
@cindex default system root
-@cindex @samp{--with-sysroot}
+@cindex @option{--with-sysroot}
You can set the default system root by using the configure-time
-@samp{--with-sysroot} option. If the system root is inside
-@value{GDBN}'s configured binary prefix (set with @samp{--prefix} or
-@samp{--exec-prefix}), then the default system root will be updated
+@option{--with-sysroot} option. If the system root is inside
+@value{GDBN}'s configured binary prefix (set with @option{--prefix} or
+@option{--exec-prefix}), then the default system root will be updated
automatically if the installed @value{GDBN} is moved to a new
location.
@@ -23220,7 +23220,7 @@ Index Files
--set-section-flags .gdb_index=readonly symfile symfile
@end smallexample
-Or for @code{-dwarf-5}:
+Or for @option{-dwarf-5}:
@smallexample
$ objcopy --dump-section .debug_str=symfile.debug_str.new symfile
@@ -23523,16 +23523,16 @@ Data Files
@end table
@cindex default data directory
-@cindex @samp{--with-gdb-datadir}
+@cindex @option{--with-gdb-datadir}
You can set the default data directory by using the configure-time
-@samp{--with-gdb-datadir} option. If the data directory is inside
-@value{GDBN}'s configured binary prefix (set with @samp{--prefix} or
-@samp{--exec-prefix}), then the default data directory will be updated
+@option{--with-gdb-datadir} option. If the data directory is inside
+@value{GDBN}'s configured binary prefix (set with @option{--prefix} or
+@option{--exec-prefix}), then the default data directory will be updated
automatically if the installed @value{GDBN} is moved to a new
location.
The data directory may also be specified with the
-@code{--data-directory} command line option.
+@option{--data-directory} command line option.
@xref{Mode Options}.
@node Targets
@@ -23990,7 +23990,7 @@ Connecting
unstripped copy of your program as the first argument, or use the
@code{file} command. Use @code{set sysroot} to specify the location (on
the host) of target libraries (unless your @value{GDBN} was compiled with
-the correct sysroot using @code{--with-sysroot}). Alternatively, you
+the correct sysroot using @option{--with-sysroot}). Alternatively, you
may use @code{set solib-search-path} to specify how @value{GDBN} locates
target libraries.
@@ -24026,7 +24026,7 @@ Connecting
@end smallexample
If you're using a serial line, you may want to give @value{GDBN} the
-@samp{--baud} option, or use the @code{set serial baud} command
+@option{--baud} option, or use the @code{set serial baud} command
(@pxref{Remote Configuration, set serial baud}) before the
@code{target} command.
@@ -24330,7 +24330,7 @@ Server
(@value{GDBP}) target remote | ssh -T hostname gdbserver - hello
@end smallexample
-The @samp{-T} option to ssh is provided because we don't need a remote pty,
+The @option{-T} option to ssh is provided because we don't need a remote pty,
and we don't want escape-character handling. Ssh does this by default when
a command is provided, the flag is provided to make it explicit.
You could elide it if you want to.
@@ -24346,7 +24346,7 @@ Server
@cindex @option{--attach}, @code{gdbserver} option
On some targets, @code{gdbserver} can also attach to running programs.
-This is accomplished via the @code{--attach} argument. The syntax is:
+This is accomplished via the @option{--attach} argument. The syntax is:
@smallexample
target> gdbserver --attach @var{comm} @var{pid}
@@ -24518,7 +24518,7 @@ Server
Load symbols for your application using the @code{file} command before you
connect. Use @code{set sysroot} to locate target libraries (unless your
@value{GDBN} was compiled with the correct sysroot using
-@code{--with-sysroot}).
+@option{--with-sysroot}).
@item
Connect to your target (@pxref{Connecting,,Connecting to a Remote Target}).
@@ -28225,7 +28225,7 @@ Command History
The @env{GDBHISTFILE} environment variable is read after processing
any @value{GDBN} initialization files (@pxref{Startup}) and after
processing any commands passed using command line options (for
-example, @code{-ex}).
+example, @option{-ex}).
If the @var{fname} argument is not given, or if the @env{GDBHISTFILE}
is the empty string then @value{GDBN} will neither try to load an
@@ -28261,7 +28261,7 @@ Command History
The @env{GDBHISTSIZE} environment variable is read after processing
any @value{GDBN} initialization files (@pxref{Startup}) and after
processing any commands passed using command line options (for
-example, @code{-ex}).
+example, @option{-ex}).
@cindex remove duplicate history
@kindex set history remove-duplicates
@@ -28883,7 +28883,7 @@ Auto-loading
@kindex set auto-load off
@item set auto-load off
Globally disable loading of all auto-loaded files.
-You may want to use this command with the @samp{-iex} option
+You may want to use this command with the @option{-iex} option
(@pxref{Option -init-eval-command}) such as:
@smallexample
$ @kbd{gdb -iex "set auto-load off" untrusted-executable corefile}
@@ -29129,7 +29129,7 @@ Auto-loading safe path
by the host platform path separator in use.
@end table
-This variable defaults to what @code{--with-auto-load-dir} has been configured
+This variable defaults to what @option{--with-auto-load-dir} has been configured
to (@pxref{with-auto-load-dir}). @file{$debugdir} and @file{$datadir}
substitution applies the same as for @ref{set auto-load scripts-directory}.
The default @code{set auto-load safe-path} value can be also overridden by
@@ -32447,9 +32447,9 @@ GDB/MI Development and Front Ends
with the old versions. Old versions of MI remain available, allowing front ends
to keep using them until they are modified to use the latest MI version.
-Since @code{--interpreter=mi} always points to the latest MI version, it is
+Since @option{--interpreter=mi} always points to the latest MI version, it is
recommended that front ends request a specific version of MI when launching
-@value{GDBN} (e.g.@: @code{--interpreter=mi2}) to make sure they get an
+@value{GDBN} (e.g.@: @option{--interpreter=mi2}) to make sure they get an
interpreter with the MI version they expect.
The following table gives a summary of the released versions of the MI
@@ -40532,7 +40532,7 @@ Debugger Adapter Protocol
is unlikely to be useful for most of them.)
@value{GDBN} provides a couple of logging settings that can be used in
-DAP mode. These can be set on the command line using the @code{-iex}
+DAP mode. These can be set on the command line using the @option{-iex}
option (@pxref{File Options}).
@table @kbd
@@ -41164,7 +41164,7 @@ Bug Reporting
@item
The command arguments you gave the compiler to compile your example and
-observe the bug. For example, did you use @samp{-O}? To guarantee
+observe the bug. For example, did you use @option{-O}? To guarantee
you will not omit something important, list them all. A copy of the
Makefile (or the output from make) is sufficient.
@@ -41631,7 +41631,7 @@ Running Configure
about missing include files such as @file{bfd/bfd.h}.
You can install @code{@value{GDBN}} anywhere. The best way to do this
-is to pass the @code{--prefix} option to @code{configure}, and then
+is to pass the @option{--prefix} option to @code{configure}, and then
install it with @code{make install}.
@node Separate Objdir
@@ -41647,11 +41647,11 @@ Separate Objdir
program specified there.
To build @code{gdb} in a separate directory, run @file{configure}
-with the @samp{--srcdir} option to specify where to find the source.
+with the @option{--srcdir} option to specify where to find the source.
(You also need to specify a path to find @file{configure}
itself from your working directory. If the path to @file{configure}
-would be the same as the argument to @samp{--srcdir}, you can leave out
-the @samp{--srcdir} option; it is assumed.)
+would be the same as the argument to @option{--srcdir}, you can leave out
+the @option{--srcdir} option; it is assumed.)
For example, with version @value{GDBVN}, you can build @value{GDBN} in a
separate directory for a Sun 4 like this:
@@ -41684,7 +41684,7 @@ Separate Objdir
@value{GDBN} runs on one machine---the @dfn{host}---while debugging
programs that run on another machine---the @dfn{target}).
You specify a cross-debugging target by
-giving the @samp{--target=@var{target}} option to @file{configure}.
+giving the @option{--target=@var{target}} option to @file{configure}.
When you run @code{make} to build a program or library, you must run
it in a configured directory---whatever directory you were in when you
@@ -41714,7 +41714,7 @@ Config Names
@end smallexample
For example, you can use the alias @code{sun4} as a @var{host} argument,
-or as the value for @var{target} in a @code{--target=@var{target}}
+or as the value for @var{target} in a @option{--target=@var{target}}
option. The equivalent full name is @samp{sparc-sun-sunos4}.
The @file{configure} script accompanying @value{GDBN} does not provide
@@ -41799,7 +41799,7 @@ Configure Options
programs that run on the same machine (@var{host}) as @value{GDBN} itself.
There is no convenient way to generate a list of all available
-targets. Also see the @code{--enable-targets} option, below.
+targets. Also see the @option{--enable-targets} option, below.
@end table
There are many other options that are specific to @value{GDBN}. This
@@ -41825,14 +41825,14 @@ Configure Options
Set the @value{GDBN}-specific data directory. @value{GDBN} will look
here for certain supporting files or scripts. This defaults to the
@file{gdb} subdirectory of @samp{datadir} (which can be set using
-@code{--datadir}).
+@option{--datadir}).
@item --with-relocated-sources=@var{dir}
Sets up the default source path substitution rule so that directory
names recorded in debug information will be automatically adjusted for
any directory under @var{dir}. @var{dir} should be a subdirectory of
@value{GDBN}'s configured prefix, the one mentioned in the
-@code{--prefix} or @code{--exec-prefix} options to configure. This
+@option{--prefix} or @option{--exec-prefix} options to configure. This
option is useful if GDB is supposed to be moved to a different place
after it is built.
@@ -41933,7 +41933,7 @@ Configure Options
file names begin with @file{/lib}' or @file{/usr/lib'}. (The value of
@var{dir} can be modified at run time by using the @command{set
sysroot} command.) If @var{dir} is under the @value{GDBN} configured
-prefix (set with @code{--prefix} or @code{--exec-prefix options}, the
+prefix (set with @option{--prefix} or @option{--exec-prefix} options, the
default system root will be automatically adjusted if and when
@value{GDBN} is moved to a different location.
@@ -41959,14 +41959,14 @@ Configure Options
compiler you are using.
@item --enable-werror
-Treat compiler warnings as errors. It adds the @code{-Werror} flag
+Treat compiler warnings as errors. It adds the @option{-Werror} flag
to the compiler, which will fail the compilation if the compiler
outputs any warning messages.
@item --enable-ubsan
Enable the GCC undefined behavior sanitizer. This is disabled by
-default, but passing @code{--enable-ubsan=yes} or
-@code{--enable-ubsan=auto} to @code{configure} will enable it. The
+default, but passing @option{--enable-ubsan=yes} or
+@option{--enable-ubsan=auto} to @code{configure} will enable it. The
undefined behavior sanitizer checks for C@t{++} undefined behavior.
It has a performance cost, so if you are looking at @value{GDBN}'s
performance, you should disable it. The undefined behavior sanitizer
@@ -42906,7 +42906,7 @@ Maintenance Commands
@cindex DWARF compilation units cache
In object files with inter-compilation-unit references, such as those
-produced by the GCC option @samp{-feliminate-dwarf2-dups}, the DWARF
+produced by the GCC option @option{-feliminate-dwarf2-dups}, the DWARF
reader needs to frequently refer to previously read compilation units.
This setting controls how long a compilation unit will remain in the
cache if it is not referenced. A higher limit means that cached
@@ -43002,8 +43002,8 @@ Maintenance Commands
(often called @file{gmon.out}). If you have a record of important profiling
data in a @file{gmon.out} file, be sure to move it to a safe location.
-Configuring with @samp{--enable-profiling} arranges for @value{GDBN} to be
-compiled with the @samp{-pg} compiler option.
+Configuring with @option{--enable-profiling} arranges for @value{GDBN} to be
+compiled with the @option{-pg} compiler option.
@kindex maint set show-debug-regs
@kindex maint show show-debug-regs
@@ -51793,7 +51793,7 @@ gdb man
@end smallexample
You can, instead, specify a process ID as a second argument or use option
-@code{-p}, if you want to debug a running process:
+@option{-p}, if you want to debug a running process:
@smallexample
gdb program 1234
@@ -51991,7 +51991,7 @@ gdb man
@noindent
starts @value{GDBN} with the introductory message, and passes the
-option @code{-q} to the inferior.
+option @option{-q} to the inferior.
The difference between @option{--args} and @option{--no-escape-args}
is whether @value{GDBN} applies escapes to the arguments it sees:
@@ -52602,7 +52602,7 @@ gdbinit man
@item (not enabled with @option{--with-system-gdbinit} during compilation)
@end ifclear
System-wide initialization file. It is executed unless user specified
-@value{GDBN} option @code{-nx} or @code{-n}.
+@value{GDBN} option @option{-nx} or @option{-n}.
See more in
@ifset man
the @value{GDBN} manual in node @code{System-wide configuration}
@@ -52615,8 +52615,8 @@ gdbinit man
@item (not enabled with @option{--with-system-gdbinit-dir} during compilation)
@end ifclear
System-wide initialization directory. All files in this directory are
-executed on startup unless user specified @value{GDBN} option @code{-nx} or
-@code{-n}, as long as they have a recognized file extension.
+executed on startup unless user specified @value{GDBN} option @option{-nx} or
+@option{-n}, as long as they have a recognized file extension.
See more in
@ifset man
the @value{GDBN} manual in node @code{System-wide configuration}
@@ -52628,7 +52628,7 @@ gdbinit man
@item @file{~/.config/gdb/gdbinit} or @file{~/.gdbinit}
User initialization file. It is executed unless user specified
-@value{GDBN} options @code{-nx}, @code{-n} or @code{-nh}.
+@value{GDBN} options @option{-nx}, @option{-n} or @option{-nh}.
@item @file{.gdbinit}
Initialization file for current directory. It may need to be enabled with
diff --git a/gdb/doc/guile.texi b/gdb/doc/guile.texi
index 91b2ad061d3..c1200258673 100644
--- a/gdb/doc/guile.texi
+++ b/gdb/doc/guile.texi
@@ -326,12 +326,12 @@ Guile Configuration
@deffn {Scheme Procedure} host-config
Return a string containing the host configuration.
-This is the string passed to @code{--host} when @value{GDBN} was configured.
+This is the string passed to @option{--host} when @value{GDBN} was configured.
@end deffn
@deffn {Scheme Procedure} target-config
Return a string containing the target configuration.
-This is the string passed to @code{--target} when @value{GDBN} was configured.
+This is the string passed to @option{--target} when @value{GDBN} was configured.
@end deffn
@node GDB Scheme Data Types
--
2.55.0
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH 5/5] gdb/doc: more @command and @kbd
2026-10-12 18:54 [PATCH 0/5] gdb/doc: a series of doc clean ups Andrew Burgess
` (3 preceding siblings ...)
2026-10-12 18:54 ` [PATCH 4/5] gdb/doc: make more use of @option{...} formatting Andrew Burgess
@ 2026-10-12 18:54 ` Andrew Burgess
2026-10-13 11:43 ` Eli Zaretskii
4 siblings, 1 reply; 12+ messages in thread
From: Andrew Burgess @ 2026-10-12 18:54 UTC (permalink / raw)
To: gdb-patches; +Cc: Andrew Burgess
I spotted some places in the docs where we used @code{...} to wrap a
command name when we should be using @command{...}. This commit
started off with me just trying to fix these.
Some cases can get a little confusing though. Consider the
documentation that discusses the GDB 'make' command. In talking about
what this GDB command does the documentation references the external
program 'make', which needs wrapping in @command{}, but there are also
mentions of the GDB command itself, which needs wrapping with @kbd{}.
As these all seemed related I've tried to clean up as many of these as
I could find. As such, this commit is mostly changing things like
@code and @samp to @command and @kbd as needed.
---
gdb/doc/gdb.texinfo | 128 ++++++++++++++++++++++----------------------
1 file changed, 64 insertions(+), 64 deletions(-)
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index e23ca31c8fc..d56ec36501b 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -842,7 +842,7 @@ Invocation
The essentials are:
@itemize @bullet
@item
-type @samp{@value{GDBP}} to start @value{GDBN}.
+type @command{@value{GDBP}} to start @value{GDBN}.
@item
type @kbd{quit}, @kbd{exit} or @kbd{Ctrl-d} to exit.
@end itemize
@@ -857,10 +857,10 @@ Invocation
@node Invoking GDB
@section Invoking @value{GDBN}
-Invoke @value{GDBN} by running the program @code{@value{GDBP}}. Once started,
+Invoke @value{GDBN} by running the program @command{@value{GDBP}}. Once started,
@value{GDBN} reads commands from the terminal until you tell it to exit.
-You can also run @code{@value{GDBP}} with a variety of arguments and options,
+You can also run @command{@value{GDBP}} with a variety of arguments and options,
to specify more of your debugging environment at the outset.
The command-line options described here are designed
@@ -900,19 +900,19 @@ Invoking GDB
``process'', and there is often no way to get a core dump. @value{GDBN}
will warn you if it is unable to attach or to read core dumps.
-You can optionally have @code{@value{GDBP}} pass any arguments after
+You can optionally have @command{@value{GDBP}} pass any arguments after
the executable file to the inferior using @option{--args} or
@option{--no-escape-args}. These options stop option processing.
@smallexample
@value{GDBP} --args gcc -O2 -c foo.c
@end smallexample
-This will cause @code{@value{GDBP}} to debug @code{gcc}, and to set
-@code{gcc}'s command-line arguments (@pxref{Arguments}) to @samp{-O2
+This will cause @command{@value{GDBP}} to debug @command{gcc}, and to set
+@command{gcc}'s command-line arguments (@pxref{Arguments}) to @samp{-O2
-c foo.c}. For the differences between @option{--args} and
@option{--no-escape-args}, see @ref{--args and --no-escape-args options,
,@option{--args} and @option{--no-escape-args}}.
-You can run @code{@value{GDBP}} without printing the front material, which describes
+You can run @command{@value{GDBP}} without printing the front material, which describes
@value{GDBN}'s non-warranty, by specifying @option{--silent}
(or @option{-q}/@option{--quiet}):
@@ -1705,16 +1705,16 @@ Shell Commands
@code{$_shell} convenience function. @xref{$_shell convenience
function}.
-The utility @code{make} is often needed in development environments.
-You do not have to use the @code{shell} command for this purpose in
+The utility @command{make} is often needed in development environments.
+You do not have to use the @kbd{shell} command for this purpose in
@value{GDBN}:
@table @kbd
@kindex make
@cindex calling make
@item make @var{make-args}
-Execute the @code{make} program with the specified
-arguments. This is equivalent to @samp{shell make @var{make-args}}.
+Execute the @command{make} program with the specified
+arguments. This is equivalent to @kbd{shell make @var{make-args}}.
@end table
@table @kbd
@@ -1776,7 +1776,7 @@ Shell Commands
The convenience variables @code{$_shell_exitcode} and @code{$_shell_exitsignal}
can be used to examine the exit status of the last shell command launched
-by @code{shell}, @code{make}, @code{pipe} and @code{|}.
+by @kbd{shell}, @kbd{make}, @kbd{pipe} and @kbd{|}.
@xref{Convenience Vars,, Convenience Variables}.
@node Logging Output
@@ -2567,7 +2567,7 @@ Help
@item show configuration
Display detailed information about the way @value{GDBN} was configured
when it was built. This displays the optional arguments passed to the
-@file{configure} script and also configuration parameters detected
+@command{configure} script and also configuration parameters detected
automatically by @command{configure}. When reporting a @value{GDBN}
bug (@pxref{GDB Bugs}), it is important to include this information in
your report.
@@ -23482,7 +23482,7 @@ Symbol Errors
@value{GDBN} circumvents the error by ignoring this symbol information.
This usually allows you to debug your program, though certain symbols
are not accessible. If you encounter such a problem and feel like
-debugging it, you can debug @code{@value{GDBP}} with itself, breakpoint
+debugging it, you can debug @command{@value{GDBP}} with itself, breakpoint
on @code{complain}, then go up to the function @code{read_dbx_symtab}
and examine @code{*bufp} to see the symbol.
@@ -41385,7 +41385,7 @@ Installing GDB
@menu
* Requirements:: Requirements for building @value{GDBN}
-* Running Configure:: Invoking the @value{GDBN} @file{configure} script
+* Running Configure:: Invoking the @value{GDBN} @command{configure} script
* Separate Objdir:: Compiling @value{GDBN} in another directory
* Config Names:: Specifying names for hosts and targets
* Configure Options:: Summary of options for configure
@@ -41407,14 +41407,14 @@ Requirements
@item GNU make
@value{GDBN}'s build system relies on features only found in the GNU
-make program. Other variants of @code{make} will not work.
+make program. Other variants of @command{make} will not work.
@item Libraries
The following libraries are mandatory for building @value{GDBN}. The
-@file{configure} script searches for each of these libraries in
+@command{configure} script searches for each of these libraries in
several standard locations; if some library is installed in an unusual
place, you can use either the @option{--with-@var{lib}}
-@file{configure} option to specify its installation directory, or
+@command{configure} option to specify its installation directory, or
the two separate options @option{---with-@var{library}-include} (to
specify the location of its header files) and
@option{--with-@var{library}-lib} (to specify the location of its
@@ -41445,13 +41445,13 @@ Requirements
@value{GDBN} can be build without them, at the expense of some run-time
functionality that will be missing. As above, we list the home sites
for each package/library, and the command-line options supported by
-the @file{configure} script to specify their installation directories
+the @command{configure} script to specify their installation directories
if they are non-standard. In addition, for each package you can use
the option @option{--with-@var{package}} to force @value{GDBN} to be
compiled with the named @var{package}, and
@option{--without-@var{package}} to disable building with it even if
it is available. @xref{Configure Options}, for detailed description
-of the options to @file{configure}.
+of the options to @command{configure}.
@table @asis
@item Python
@@ -41508,9 +41508,9 @@ Requirements
library; its latest version can be found on
@url{https://ftp.gnu.org/pub/gnu/libiconv/} if your system doesn't
provide it. Use the @option{--with-libiconv-prefix} option to
-@file{configure} to specify non-standard installation place for it.
+@command{configure} to specify non-standard installation place for it.
-Alternatively, @value{GDBN}'s top-level @file{configure} and
+Alternatively, @value{GDBN}'s top-level @command{configure} and
@file{Makefile} will arrange to build Libiconv if a directory named
@file{libiconv} appears in the top-most source directory. If Libiconv
is built this way, and if the operating system does not provide a
@@ -41545,11 +41545,11 @@ Requirements
@end table
@node Running Configure
-@section Invoking the @value{GDBN} @file{configure} Script
+@section Invoking the @value{GDBN} @command{configure} Script
@cindex configuring @value{GDBN}
-@value{GDBN} comes with a @file{configure} script that automates the process
-of preparing @value{GDBN} for installation; you can then use @code{make} to
-build the @code{gdb} program.
+@value{GDBN} comes with a @command{configure} script that automates the process
+of preparing @value{GDBN} for installation; you can then use @command{make} to
+build the @command{@value{GDBP}} program.
@iftex
@c irrelevant in info file; it's as current as the code it lives with.
@footnote{If you have a more recent version of @value{GDBN} than @value{GDBVN},
@@ -41589,12 +41589,12 @@ Running Configure
There may be other subdirectories as well.
-The simplest way to configure and build @value{GDBN} is to run @file{configure}
+The simplest way to configure and build @value{GDBN} is to run @command{configure}
from the @file{gdb-@var{version-number}} source directory, which in
this example is the @file{gdb-@value{GDBVN}} directory.
First switch to the @file{gdb-@var{version-number}} source directory
-if you are not already in it; then run @file{configure}. Pass the
+if you are not already in it; then run @command{configure}. Pass the
identifier for the platform on which @value{GDBN} will run as an
argument.
@@ -41606,13 +41606,13 @@ Running Configure
make
@end smallexample
-Running @samp{configure} and then running @code{make} builds the
-included supporting libraries, then @code{gdb} itself. The configured
+Running @command{configure} and then running @command{make} builds the
+included supporting libraries, then @command{@value{GDBP}} itself. The configured
source files, and the binaries, are left in the corresponding source
directories.
@need 750
-@file{configure} is a Bourne-shell (@code{/bin/sh}) script; if your
+@command{configure} is a Bourne-shell (@code{/bin/sh}) script; if your
system does not recognize this automatically when you run a different
shell, you may need to run @code{sh} on it explicitly:
@@ -41620,18 +41620,18 @@ Running Configure
sh configure
@end smallexample
-You should run the @file{configure} script from the top directory in the
+You should run the @command{configure} script from the top directory in the
source tree, the @file{gdb-@var{version-number}} directory. If you run
-@file{configure} from one of the subdirectories, you will configure only
+@command{configure} from one of the subdirectories, you will configure only
that subdirectory. That is usually not what you want. In particular,
-if you run the first @file{configure} from the @file{gdb} subdirectory
+if you run the first @command{configure} from the @file{gdb} subdirectory
of the @file{gdb-@var{version-number}} directory, you will omit the
configuration of @file{bfd}, @file{readline}, and other sibling
directories of the @file{gdb} subdirectory. This leads to build errors
about missing include files such as @file{bfd/bfd.h}.
You can install @code{@value{GDBN}} anywhere. The best way to do this
-is to pass the @option{--prefix} option to @code{configure}, and then
+is to pass the @option{--prefix} option to @command{configure}, and then
install it with @code{make install}.
@node Separate Objdir
@@ -41639,17 +41639,17 @@ Separate Objdir
If you want to run @value{GDBN} versions for several host or target machines,
you need a different @code{gdb} compiled for each combination of
-host and target. @file{configure} is designed to make this easy by
+host and target. @command{configure} is designed to make this easy by
allowing you to generate each configuration in a separate subdirectory,
-rather than in the source directory. If your @code{make} program
-handles the @samp{VPATH} feature (@sc{gnu} @code{make} does), running
-@code{make} in each of these directories builds the @code{gdb}
+rather than in the source directory. If your @command{make} program
+handles the @samp{VPATH} feature (@sc{gnu} @command{make} does), running
+@command{make} in each of these directories builds the @command{@value{GDBP}}
program specified there.
-To build @code{gdb} in a separate directory, run @file{configure}
+To build @code{gdb} in a separate directory, run @command{configure}
with the @option{--srcdir} option to specify where to find the source.
-(You also need to specify a path to find @file{configure}
-itself from your working directory. If the path to @file{configure}
+(You also need to specify a path to find @command{configure}
+itself from your working directory. If the path to @command{configure}
would be the same as the argument to @option{--srcdir}, you can leave out
the @option{--srcdir} option; it is assumed.)
@@ -41666,15 +41666,15 @@ Separate Objdir
@end group
@end smallexample
-When @file{configure} builds a configuration using a remote source
+When @command{configure} builds a configuration using a remote source
directory, it creates a tree for the binaries with the same structure
(and using the same names) as the tree under the source directory. In
the example, you'd find the Sun 4 library @file{libiberty.a} in the
directory @file{gdb-sun4/libiberty}, and @value{GDBN} itself in
@file{gdb-sun4/gdb}.
-Make sure that your path to the @file{configure} script has just one
-instance of @file{gdb} in it. If your path to @file{configure} looks
+Make sure that your path to the @command{configure} script has just one
+instance of @file{gdb} in it. If your path to @command{configure} looks
like @file{../gdb-@value{GDBVN}/gdb/configure}, you are configuring only
one subdirectory of @value{GDBN}, not the whole package. This leads to
build errors about missing include files such as @file{bfd/bfd.h}.
@@ -41684,27 +41684,27 @@ Separate Objdir
@value{GDBN} runs on one machine---the @dfn{host}---while debugging
programs that run on another machine---the @dfn{target}).
You specify a cross-debugging target by
-giving the @option{--target=@var{target}} option to @file{configure}.
+giving the @option{--target=@var{target}} option to @command{configure}.
-When you run @code{make} to build a program or library, you must run
+When you run @command{make} to build a program or library, you must run
it in a configured directory---whatever directory you were in when you
-called @file{configure} (or one of its subdirectories).
+called @command{configure} (or one of its subdirectories).
-The @code{Makefile} that @file{configure} generates in each source
-directory also runs recursively. If you type @code{make} in a source
+The @file{Makefile} that @command{configure} generates in each source
+directory also runs recursively. If you invoke @command{make} in a source
directory such as @file{gdb-@value{GDBVN}} (or in a separate configured
directory configured with @samp{--srcdir=@var{dirname}/gdb-@value{GDBVN}}), you
-will build all the required libraries, and then build GDB.
+will build all the required libraries, and then build @command{@value{GDBP}}.
When you have multiple hosts or targets configured in separate
-directories, you can run @code{make} on them in parallel (for example,
+directories, you can run @command{make} on them in parallel (for example,
if they are NFS-mounted on each of the hosts); they will not interfere
with each other.
@node Config Names
@section Specifying Names for Hosts and Targets
-The specifications used for hosts and targets in the @file{configure}
+The specifications used for hosts and targets in the @command{configure}
script are based on a three-part naming scheme, but some short predefined
aliases are also supported. The full naming scheme encodes three pieces
of information in the following pattern:
@@ -41717,9 +41717,9 @@ Config Names
or as the value for @var{target} in a @option{--target=@var{target}}
option. The equivalent full name is @samp{sparc-sun-sunos4}.
-The @file{configure} script accompanying @value{GDBN} does not provide
+The @command{configure} script accompanying @value{GDBN} does not provide
any query facility to list all supported host and target names or
-aliases. @file{configure} calls the Bourne shell script
+aliases. @command{configure} calls the Bourne shell script
@code{config.sub} to map abbreviations to full names; you can read the
script, if you wish, or you can use it to test your guesses on
abbreviations---for example:
@@ -41744,17 +41744,17 @@ Config Names
directory (@file{gdb-@value{GDBVN}}, for version @value{GDBVN}).
@node Configure Options
-@section @file{configure} Options
+@section @command{configure} Options
@c FIXME: This largely repeats what was already described in
@c ``Requirements'', and OTOH doesn't describe the more fgine-granular
@c options like --with-libexpat-prefix and --with-python-libdir.
@c Should it?
-Here is a summary of the @file{configure} options and arguments that
-are most often useful for building @value{GDBN}. @file{configure}
+Here is a summary of the @command{configure} options and arguments that
+are most often useful for building @value{GDBN}. @command{configure}
also has several other options not listed here. @xref{Running
configure Scripts,,,autoconf}, for a full
-explanation of @file{configure}.
+explanation of @command{configure}.
@smallexample
configure @r{[}--help@r{]}
@@ -41771,7 +41771,7 @@ Configure Options
@table @option
@item --help
-Display a quick summary of how to invoke @file{configure}.
+Display a quick summary of how to invoke @command{configure}.
@item --prefix=@var{dir}
Configure the source to install programs and files under directory
@@ -41787,9 +41787,9 @@ Configure Options
Use this option to make configurations in directories separate from the
@value{GDBN} source directories. Among other things, you can use this to
build (or maintain) several configurations simultaneously, in separate
-directories. @file{configure} writes configuration-specific files in
+directories. @command{configure} writes configuration-specific files in
the current directory, but arranges for them to use the source in the
-directory @var{dirname}. @file{configure} creates directories under
+directory @var{dirname}. @command{configure} creates directories under
the working directory in parallel to the source directories below
@var{dirname}.
@@ -41918,7 +41918,7 @@ Configure Options
if libguile is present and found at configure time.) If your host
does not have Guile installed, you can find it at
@url{https://www.gnu.org/software/guile/}. The optional argument @var{guile}
-can be a version number, which will cause @code{configure} to try to
+can be a version number, which will cause @command{configure} to try to
use that version of Guile; or the file name of a @code{pkg-config}
executable, which will be queried to find the information needed to
compile and link against Guile.
@@ -41966,7 +41966,7 @@ Configure Options
@item --enable-ubsan
Enable the GCC undefined behavior sanitizer. This is disabled by
default, but passing @option{--enable-ubsan=yes} or
-@option{--enable-ubsan=auto} to @code{configure} will enable it. The
+@option{--enable-ubsan=auto} to @command{configure} will enable it. The
undefined behavior sanitizer checks for C@t{++} undefined behavior.
It has a performance cost, so if you are looking at @value{GDBN}'s
performance, you should disable it. The undefined behavior sanitizer
--
2.55.0
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 3/5] gdb/doc: consistent formatting for on|off on @item lines
2026-10-12 18:54 ` [PATCH 3/5] gdb/doc: consistent formatting for on|off on @item lines Andrew Burgess
@ 2026-10-13 11:33 ` Eli Zaretskii
0 siblings, 0 replies; 12+ messages in thread
From: Eli Zaretskii @ 2026-10-13 11:33 UTC (permalink / raw)
To: Andrew Burgess; +Cc: gdb-patches
> From: Andrew Burgess <aburgess@redhat.com>
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Mon, 12 Oct 2026 19:54:28 +0100
>
> When a command takes 'on' or 'off' as an option then we have a bunch
> of styles for how this is presented within a table's @item line:
>
> @item set logging enabled [on|off]
> @item -past-main [@code{on}|@code{off}]
> @item set auto-load python-scripts @r{[}on@r{|}off@r{]}
>
> Of these the last seems to be the style that is most often used for
> new additions. I think it's the correct one because:
>
> 1. Use @r{...} to wrap the characters that are not part of the
> command: [|], this ensures these characters are formatted as
> normal text, not using the table style, which should be @kbd.
>
> 2. Wrapping 'on' and 'off' in @code{...} is clearly wrong, there
> are not code. Using @samp{...} might work, but this isn't what
> we currently do, and the 'on' and 'off' could be considered just
> another part of the command, so using the table's default @kbd
> style seems reasonable enough.
>
> This commit updates some cases in the documentation which used the
> first two styles to use the third style, this makes things more
> consistent.
> ---
> gdb/doc/gdb.texinfo | 78 ++++++++++++++++++++++-----------------------
> gdb/doc/guile.texi | 4 +--
> gdb/doc/python.texi | 4 +--
> 3 files changed, 43 insertions(+), 43 deletions(-)
Thanks, this is okay.
Approved-By: Eli Zaretskii <eliz@gnu.org>
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 5/5] gdb/doc: more @command and @kbd
2026-10-12 18:54 ` [PATCH 5/5] gdb/doc: more @command and @kbd Andrew Burgess
@ 2026-10-13 11:43 ` Eli Zaretskii
2026-10-16 14:52 ` Andrew Burgess
0 siblings, 1 reply; 12+ messages in thread
From: Eli Zaretskii @ 2026-10-13 11:43 UTC (permalink / raw)
To: Andrew Burgess; +Cc: gdb-patches
> From: Andrew Burgess <aburgess@redhat.com>
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Mon, 12 Oct 2026 19:54:30 +0100
>
> I spotted some places in the docs where we used @code{...} to wrap a
> command name when we should be using @command{...}. This commit
> started off with me just trying to fix these.
>
> Some cases can get a little confusing though. Consider the
> documentation that discusses the GDB 'make' command. In talking about
> what this GDB command does the documentation references the external
> program 'make', which needs wrapping in @command{}, but there are also
> mentions of the GDB command itself, which needs wrapping with @kbd{}.
>
> As these all seemed related I've tried to clean up as many of these as
> I could find. As such, this commit is mostly changing things like
> @code and @samp to @command and @kbd as needed.
> ---
> gdb/doc/gdb.texinfo | 128 ++++++++++++++++++++++----------------------
> 1 file changed, 64 insertions(+), 64 deletions(-)
Thanks, this is okay, with a couple of nits below fixed.
> @item GNU make
> @value{GDBN}'s build system relies on features only found in the GNU
> -make program. Other variants of @code{make} will not work.
> +make program. Other variants of @command{make} will not work.
^^^^
This should also be in @command.
> -To build @code{gdb} in a separate directory, run @file{configure}
> +To build @code{gdb} in a separate directory, run @command{configure}
^^^^^^^^^^
This should use @value{GDBN}.
Approved-By: Eli Zaretskii <eliz@gnu.org>
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 1/5] gdb/doc: use (@value{GDBP}) for the prompt in examples
2026-10-12 18:54 ` [PATCH 1/5] gdb/doc: use (@value{GDBP}) for the prompt in examples Andrew Burgess
@ 2026-10-13 11:43 ` Eli Zaretskii
0 siblings, 0 replies; 12+ messages in thread
From: Eli Zaretskii @ 2026-10-13 11:43 UTC (permalink / raw)
To: Andrew Burgess; +Cc: gdb-patches
> From: Andrew Burgess <aburgess@redhat.com>
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Mon, 12 Oct 2026 19:54:26 +0100
>
> Within examples we should be using (@value{GDBP}) not '(gdb)'. There
> are several places where we don't do this, fix them now.
> ---
> gdb/doc/gdb.texinfo | 648 ++++++++++++++++++++++----------------------
> gdb/doc/guile.texi | 50 ++--
> gdb/doc/python.texi | 38 +--
> 3 files changed, 368 insertions(+), 368 deletions(-)
Thanks, this is okay.
Approved-By: Eli Zaretskii <eliz@gnu.org>
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 2/5] gdb/doc: fix some incorrect '@table @code' uses
2026-10-12 18:54 ` [PATCH 2/5] gdb/doc: fix some incorrect '@table @code' uses Andrew Burgess
@ 2026-10-13 11:56 ` Eli Zaretskii
0 siblings, 0 replies; 12+ messages in thread
From: Eli Zaretskii @ 2026-10-13 11:56 UTC (permalink / raw)
To: Andrew Burgess; +Cc: gdb-patches
> From: Andrew Burgess <aburgess@redhat.com>
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Mon, 12 Oct 2026 19:54:27 +0100
>
> When we have something like this:
>
> @table @code
> @item blah
> This is the text.
> @end table
>
> Then the 'blah' text is formatted as '@code{blah}'. We have several
> places in the GDB docs where we use '@table @code' when there is a
> better alternative than @code.
>
> I also found a few places where we did something like:
>
> @table @code
> @item @code{blah}
> This is the text.
> @end table
>
> In this case the @code around 'blah' is unnecessary, as the table
> already applies @code formatting. In this case I've removed the
> formatting around the blah text.
>
> I also spotted this pattern:
>
> @table @code
> @item @var{blah}, some additional explanation.
> This is the text.
> @end table
>
> In this case 'blah' is formatted as @var and 'some additional
> explanation' is formatted as @code, when I think it is really just
> normal text. In this case I change the @code to @asis which will
> leave the additional text as-is, i.e. with no special formatting.
>
> I have not tried to check every @table in the docs. This patch mostly
> focused on @code to @kbd, though I did fix up a few other tables where
> it was obvious that something else should be applied. However, there
> are a lot of tables in the docs, my strategy was to basically spend no
> more than a second or two looking at a table, if it wasn't immediately
> obvious what change was needed then I left the table as @code. My
> hope is that this patch improves the quality of the docs.
> ---
> gdb/doc/gdb.texinfo | 622 ++++++++++++++++++++++----------------------
> gdb/doc/guile.texi | 6 +-
> gdb/doc/python.texi | 16 +-
> 3 files changed, 322 insertions(+), 322 deletions(-)
Thanks, this is okay. I have a comments:
> -@table @code
> +@table @asis
> @item @var{linenum}
> @itemx @var{filename}:@var{linenum}
> @itemx -line @var{linenum}
There's nothing wrong with having a @var inside @code, we do it in
many manuals all the time. The problem happens when there are words
in such a table which should neither be in @code nor in @var; but
there are no such cases here, AFAICT. OTOH, changing to @asis makes
the "@item -line" have the wrong typeface: it should be in @code.
So I would leave this case alone.
Approved-By: Eli Zaretskii <eliz@gnu.org>
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 4/5] gdb/doc: make more use of @option{...} formatting
2026-10-12 18:54 ` [PATCH 4/5] gdb/doc: make more use of @option{...} formatting Andrew Burgess
@ 2026-10-13 12:00 ` Eli Zaretskii
0 siblings, 0 replies; 12+ messages in thread
From: Eli Zaretskii @ 2026-10-13 12:00 UTC (permalink / raw)
To: Andrew Burgess; +Cc: gdb-patches
> From: Andrew Burgess <aburgess@redhat.com>
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Mon, 12 Oct 2026 19:54:29 +0100
>
> I noticed that there are lots of places in our docs where command line
> options, either for GDB or for other programs (e.g. compilers) are
> formatted as either @code or @samp.
Historically, @option was not originally available in Texinfo, that's
why we have so many @samp instead.
> In this commit I made use of regexp replacement looking for anything
> that matched: "@(code|samp)\{-[^}]+\}" and if I was reasonably certain
> that it was a command line option I switched to use @option{...}. If
> I had any doubt then I left things as they were.
>
> I'm sure that there are places that I've missed, but hopefully this
> makes the docs a little better.
> ---
> gdb/doc/gdb.texinfo | 350 ++++++++++++++++++++++----------------------
> gdb/doc/guile.texi | 4 +-
> 2 files changed, 177 insertions(+), 177 deletions(-)
Thanks, this is okay.
Approved-By: Eli Zaretskii <eliz@gnu.org>
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 5/5] gdb/doc: more @command and @kbd
2026-10-13 11:43 ` Eli Zaretskii
@ 2026-10-16 14:52 ` Andrew Burgess
0 siblings, 0 replies; 12+ messages in thread
From: Andrew Burgess @ 2026-10-16 14:52 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: gdb-patches
Eli Zaretskii <eliz@gnu.org> writes:
>> From: Andrew Burgess <aburgess@redhat.com>
>> Cc: Andrew Burgess <aburgess@redhat.com>
>> Date: Mon, 12 Oct 2026 19:54:30 +0100
>>
>> I spotted some places in the docs where we used @code{...} to wrap a
>> command name when we should be using @command{...}. This commit
>> started off with me just trying to fix these.
>>
>> Some cases can get a little confusing though. Consider the
>> documentation that discusses the GDB 'make' command. In talking about
>> what this GDB command does the documentation references the external
>> program 'make', which needs wrapping in @command{}, but there are also
>> mentions of the GDB command itself, which needs wrapping with @kbd{}.
>>
>> As these all seemed related I've tried to clean up as many of these as
>> I could find. As such, this commit is mostly changing things like
>> @code and @samp to @command and @kbd as needed.
>> ---
>> gdb/doc/gdb.texinfo | 128 ++++++++++++++++++++++----------------------
>> 1 file changed, 64 insertions(+), 64 deletions(-)
>
> Thanks, this is okay, with a couple of nits below fixed.
>
>> @item GNU make
>> @value{GDBN}'s build system relies on features only found in the GNU
>> -make program. Other variants of @code{make} will not work.
>> +make program. Other variants of @command{make} will not work.
> ^^^^
> This should also be in @command.
>
>> -To build @code{gdb} in a separate directory, run @file{configure}
>> +To build @code{gdb} in a separate directory, run @command{configure}
> ^^^^^^^^^^
> This should use @value{GDBN}.
>
> Approved-By: Eli Zaretskii <eliz@gnu.org>
Eli,
I addressed the nits you pointed out and pushed this series.
Thanks,
Andrew
^ permalink raw reply [flat|nested] 12+ messages in thread
end of thread, other threads:[~2026-10-16 14:54 UTC | newest]
Thread overview: 12+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-10-12 18:54 [PATCH 0/5] gdb/doc: a series of doc clean ups Andrew Burgess
2026-10-12 18:54 ` [PATCH 1/5] gdb/doc: use (@value{GDBP}) for the prompt in examples Andrew Burgess
2026-10-13 11:43 ` Eli Zaretskii
2026-10-12 18:54 ` [PATCH 2/5] gdb/doc: fix some incorrect '@table @code' uses Andrew Burgess
2026-10-13 11:56 ` Eli Zaretskii
2026-10-12 18:54 ` [PATCH 3/5] gdb/doc: consistent formatting for on|off on @item lines Andrew Burgess
2026-10-13 11:33 ` Eli Zaretskii
2026-10-12 18:54 ` [PATCH 4/5] gdb/doc: make more use of @option{...} formatting Andrew Burgess
2026-10-13 12:00 ` Eli Zaretskii
2026-10-12 18:54 ` [PATCH 5/5] gdb/doc: more @command and @kbd Andrew Burgess
2026-10-13 11:43 ` Eli Zaretskii
2026-10-16 14:52 ` Andrew Burgess
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox