public inbox for gdb-cvs@sourceware.org
help / color / mirror / Atom feed
* [binutils-gdb] GDB/doc: Remove extraneous spaces from completion examples
@ 2022-07-01 16:12 Maciej W. Rozycki
0 siblings, 0 replies; only message in thread
From: Maciej W. Rozycki @ 2022-07-01 16:12 UTC (permalink / raw)
To: gdb-cvs
https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=c4de64f8f6df99078d55d329bed24bbe3b963aba
commit c4de64f8f6df99078d55d329bed24bbe3b963aba
Author: Maciej W. Rozycki <macro@embecosm.com>
Date: Fri Jul 1 17:11:09 2022 +0100
GDB/doc: Remove extraneous spaces from completion examples
Completion results are usually different when the operation is applied
to a word that is or is not followed by a space. In some cases they are
equivalent, however a space would not be produced if completion was used
earlier on in the word processed.
However in the manual we have completion examples given using a space
that actually prevents the example from working. E.g.:
(gdb) info bre <TAB>
(nothing) and:
(gdb) info bre <TAB><TAB>
Display all 200 possibilities? (y or n)
as it now goes on to propose the entire symbol table, while:
(gdb) info bre<TAB>
(gdb) info breakpoints
does the right thing, but is not what is shown in the manual.
In other cases an extraneous space is used that does not correspond to
the actual completion pattern shown, which gives an impression of
sloppiness.
Remove extraneous spaces then from completion examples as appropriate.
Diff:
---
gdb/doc/gdb.texinfo | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index f7b02c262b8..ad5bc7db01e 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -1915,7 +1915,7 @@ enter it). For example, if you type
@c If texinfo enhancements make it unnecessary, it would be nice to
@c replace " @key" by "@key" in the following...
@smallexample
-(@value{GDBP}) info bre @key{TAB}
+(@value{GDBP}) info bre@key{TAB}
@end smallexample
@noindent
@@ -1945,7 +1945,7 @@ function names in your program that begin with those characters, for
example:
@smallexample
-(@value{GDBP}) b make_ @key{TAB}
+(@value{GDBP}) b make_@key{TAB}
@exdent @value{GDBN} sounds bell; press @key{TAB} again, to see:
make_a_section_from_file make_environ
make_abs_section make_function_type
@@ -2039,7 +2039,7 @@ the word-completion facilities in this situation, type a single quote
when you press @key{TAB} or @kbd{M-?} to request word completion:
@smallexample
-(@value{GDBP}) p 'func< @kbd{M-?}
+(@value{GDBP}) p 'func<@kbd{M-?}
func<int>() func<float>()
(@value{GDBP}) p 'func<
@end smallexample
@@ -2050,7 +2050,7 @@ usually need to type a quote before the function name, because
function:
@smallexample
-(@value{GDBP}) b func< @kbd{M-?}
+(@value{GDBP}) b func<@kbd{M-?}
func<int>() func<float>()
(@value{GDBP}) b func<
@end smallexample
@@ -2063,9 +2063,9 @@ that takes an @code{int} parameter, @code{name(int)}, or the version
that takes a @code{float} parameter, @code{name(float)}.
@smallexample
-(@value{GDBP}) b bubble( @kbd{M-?}
+(@value{GDBP}) b bubble(@kbd{M-?}
bubble(int) bubble(double)
-(@value{GDBP}) b bubble(dou @kbd{M-?}
+(@value{GDBP}) b bubble(dou@kbd{M-?}
bubble(double)
@end smallexample
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2022-07-01 16:12 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-07-01 16:12 [binutils-gdb] GDB/doc: Remove extraneous spaces from completion examples Maciej W. Rozycki
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).