GDB/doc: Document the Guile `#:unlimited' keyword
authorMaciej W. Rozycki <macro@embecosm.com>
Thu, 1 Sep 2022 10:30:18 +0000 (11:30 +0100)
committerMaciej W. Rozycki <macro@embecosm.com>
Thu, 1 Sep 2022 10:30:18 +0000 (11:30 +0100)
Document the Guile `#:unlimited' keyword and deprecate the internal
integer representation it corresponds to for integer parameters.

gdb/doc/guile.texi

index 63916eed181b2bb3dc93e046280af2dfec83732b..ba916009f746f1d6f635fec12aee17db004e74df 100644 (file)
@@ -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