From: Maciej W. Rozycki <macro@embecosm.com>
Date: Thu, 1 Sep 2022 10:30:18 +0000 (+0100)
Subject: GDB/doc: Document the Guile `#:unlimited' keyword
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=7b0d7ede79f548915641ac5916fbeb77fc9c44ff;p=binutils-gdb.git

GDB/doc: Document the Guile `#:unlimited' keyword

Document the Guile `#:unlimited' keyword and deprecate the internal
integer representation it corresponds to for integer parameters.
---

diff --git a/gdb/doc/guile.texi b/gdb/doc/guile.texi
index 63916eed181..ba916009f74 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