mirrors/binutils-gdb
0
0
Fork 0
mirror of https://sourceware.org/git/binutils-gdb.git synced 2024-12-03 07:14:18 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

gdb/doc: add missing parentheses around prompt in some examples

Browse Source 
While reading the manual for -info-os I noticed that the GDB prompt is
given as 'gdb' when it should really be '(gdb)'.  This is because the
prompt is created with: '@value{GDBP}'.

The GDBP variable (the GDB program name) is intended for use as the
prompt string (though this is not used consistently throughout the
manual), however it is normally used like '(@value{GDBP})', but in a
couple of places the enclosing parentheses are missing.

In this commit I do the following:

 - Change '@value{GDBP}' to '(@value{GDBP})' wherever the variable
   represents a prompt string.

 - Replaces '(gdb)' with '(@value{GDBP})' in one example where we are
   already using '(@value{GDBP})', this makes that one example
   consistent.

I have NOT:

 - Changed all instances of '(gdb)' with '(@value{GDBP})', this would
   be a huge change.

gdb/doc/ChangeLog:

	* gdb.texinfo (GDB/MI Miscellaneous Commands): Add missing
	parentheses to GDB prompt in example, and replace '(gdb)' with
	'(@value{GDBP})' in one example where the latter was already in
	use.
This commit is contained in:
Andrew Burgess 2021-04-14 13:14:27 +01:00
parent 38ae29156f
commit b9de3b915c
2 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
gdb/doc/ChangeLog
View File

@ -1,3 +1,10 @@
2021-04-14 Andrew Burgess <andrew.burgess@embecosm.com>
* gdb.texinfo (GDB/MI Miscellaneous Commands): Add missing
parentheses to GDB prompt in example, and replace '(gdb)' with
'(@value{GDBP})' in one example where the latter was already in
use.
2021-03-29 Luis Machado <luis.machado@linaro.org>
* gdb.textinfo (Memory Tagging): Make it a @section.

10
gdb/doc/gdb.texinfo
View File

@ -36513,7 +36513,7 @@ and only if there is a corresponding executable file.
@subheading Example
@smallexample
@value{GDBP}
(@value{GDBP})
-list-thread-groups
^done,groups=[@{id="17",type="process",pid="yyy",num_children="2"@}]
-list-thread-groups 17
@ -36561,7 +36561,7 @@ When run on a @sc{gnu}/Linux system, the output will look something
like this:
@smallexample
@value{GDBP}
(@value{GDBP})
-info-os
^done,OSDataTable=@{nr_rows="10",nr_cols="3",
hdr=[@{width="10",alignment="-1",col_name="col0",colhdr="Type"@},
@ -36587,7 +36587,7 @@ body=[item=@{col0="cpus",col1="Listing of all cpus/cores on the system",
col2="Sockets"@},
item=@{col0="threads",col1="Listing of all threads",
col2="Threads"@}]
@value{GDBP}
(@value{GDBP})
-info-os processes
^done,OSDataTable=@{nr_rows="190",nr_cols="4",
hdr=[@{width="10",alignment="-1",col_name="col0",colhdr="pid"@},
@ -36600,7 +36600,7 @@ body=[item=@{col0="1",col1="root",col2="/sbin/init",col3="0"@},
...
item=@{col0="26446",col1="stan",col2="bash",col3="0"@},
item=@{col0="28152",col1="stan",col2="bash",col3="1"@}]@}
(gdb)
(@value{GDBP})
@end smallexample
(Note that the MI output here includes a @code{"Title"} column that
@ -36628,7 +36628,7 @@ thread group corresponding to the new inferior.
@subheading Example
@smallexample
@value{GDBP}
(@value{GDBP})
-add-inferior
^done,inferior="i3"
@end smallexample