]> git.ipfire.org Git - thirdparty/binutils-gdb.git/commitdiff
gdb/doc: fix incorrect use of @value
authorAndrew Burgess <aburgess@redhat.com>
Tue, 16 Dec 2025 10:00:38 +0000 (10:00 +0000)
committerAndrew Burgess <aburgess@redhat.com>
Tue, 16 Dec 2025 10:03:25 +0000 (10:03 +0000)
In commit:

  commit 255a9c42709958d0925d1d0d1d39d262972fd2a6
  Date:   Fri Dec 5 11:33:29 2025 +0000

      gdb: new setting to disable progress bars

I incorrectly used @value{on} and @value{off} to reference the on/off
settings of a new flag.  This caused the following warnings when
building the docs:

  gdb.texinfo:51356: warning: undefined flag: off
  gdb.texinfo:51357: warning: undefined flag: on

Looking through the docs there seems to be a split, in some cases we
use @code and in others we use @samp.  I'm not sure @code is correct,
so I've switched to use @samp.  The warnings are gone after this
patch.

gdb/doc/gdb.texinfo

index 4c012393ff48e6620198ab6e875d617abf9bc9d7..f77fe17c81fe2cb17e092add4b338bd0940fe138 100644 (file)
@@ -51353,8 +51353,8 @@ Show the current verbosity setting.
 @cindex progress bars, disabling
 @item set progress-bars enabled @r{[}on@r{|}off@r{]}
 Set whether @value{GDBN} can display a progress bar when downloading a
-file from debuginfod.  When @value{off}, @value{GDBN} will not display
-a progress bar.  When @value{on}, @value{GDBN} will display a progress
+file from debuginfod.  When @samp{off}, @value{GDBN} will not display
+a progress bar.  When @samp{on}, @value{GDBN} will display a progress
 bar if @value{GDBN}'s output console supports it.
 
 @kindex show progress-bars enabled