aboutsummaryrefslogtreecommitdiff
path: root/gdb/doc
diff options
context:
space:
mode:
authorMaciej W. Rozycki <macro@embecosm.com>2022-09-01 11:30:18 +0100
committerMaciej W. Rozycki <macro@embecosm.com>2022-09-01 11:30:18 +0100
commit7b0d7ede79f548915641ac5916fbeb77fc9c44ff (patch)
treee63086b6536ceb1b8e5ed47a1efbb3611399de13 /gdb/doc
parentbe2057b902e834bba6fe7d3ded16177ec5624f3b (diff)
downloadgdb-7b0d7ede79f548915641ac5916fbeb77fc9c44ff.zip
gdb-7b0d7ede79f548915641ac5916fbeb77fc9c44ff.tar.gz
gdb-7b0d7ede79f548915641ac5916fbeb77fc9c44ff.tar.bz2
GDB/doc: Document the Guile `#:unlimited' keyword
Document the Guile `#:unlimited' keyword and deprecate the internal integer representation it corresponds to for integer parameters.
Diffstat (limited to 'gdb/doc')
-rw-r--r--gdb/doc/guile.texi12
1 files changed, 7 insertions, 5 deletions
diff --git a/gdb/doc/guile.texi b/gdb/doc/guile.texi
index 63916ee..ba91600 100644
--- a/gdb/doc/guile.texi
+++ b/gdb/doc/guile.texi
@@ -2135,8 +2135,9 @@ Guile, true and false are represented using boolean constants, and
@samp{auto} is represented using @code{#:auto}.
@item PARAM_UINTEGER
-The value is an unsigned integer. The value of 0 should be
-interpreted to mean ``unlimited''.
+The value is an unsigned integer. The value of @code{#:unlimited}
+should be interpreted to mean ``unlimited'', and the value of @samp{0}
+is reserved and should not be used.
@item PARAM_ZINTEGER
The value is an integer.
@@ -2145,9 +2146,10 @@ The value is an integer.
The value is an unsigned integer.
@item PARAM_ZUINTEGER_UNLIMITED
-The value is an integer in the range @samp{[0, INT_MAX]}.
-A value of @samp{-1} means ``unlimited'', and other negative
-numbers are not allowed.
+The value is an integer in the range @samp{[0, INT_MAX]}. The value
+of @code{#:unlimited} means ``unlimited'', the value of @samp{-1} is
+reserved and should not be used, and other negative numbers are not
+allowed.
@item PARAM_STRING
The value is a string. When the user modifies the string, any escape