GDB/doc: Remove extraneous spaces from completion examples
authorMaciej W. Rozycki <macro@embecosm.com>
Fri, 1 Jul 2022 16:11:09 +0000 (17:11 +0100)
committerMaciej W. Rozycki <macro@embecosm.com>
Fri, 1 Jul 2022 16:11:09 +0000 (17:11 +0100)
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.

gdb/doc/gdb.texinfo

index f7b02c262b841c15d562d62d71037cb3396c4d2f..ad5bc7db01ec6e2e6dabcf2a547a15314b3aeca1 100644 (file)
@@ -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