[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 16/35: [docs]: Tweak discussion of \n[slimit].
From: |
G. Branden Robinson |
Subject: |
[groff] 16/35: [docs]: Tweak discussion of \n[slimit]. |
Date: |
Mon, 25 Oct 2021 03:32:37 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 4a1754f18f48154112f37ac67432625381da6382
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Oct 23 13:20:39 2021 +1100
[docs]: Tweak discussion of \n[slimit].
Make the presentation slightly more accessible by identifying troff's
"input stack" as something "internal"; a user doesn't need to have any
deep understanding of it to use troff.
Also say "program memory" instead of "virtual memory". Not only is
there no reason to throw OS/computer architecture jargon around, but our
interface to the system neither requires a virtual memory implementation
nor knows anything about what underlies the "heap" or "free store" we
use for memory allocation at run time.
---
doc/groff.texi | 10 ++++------
man/groff.7.man | 15 ++++++++++++---
man/groff_diff.7.man | 15 ++++++++++-----
3 files changed, 26 insertions(+), 14 deletions(-)
diff --git a/doc/groff.texi b/doc/groff.texi
index ac6cab4..be076ed 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -15463,12 +15463,10 @@ generated on each error or warning. Some warnings
have to be enabled;
@Defreg {slimit}
@cindex input stack, setting limit
-Use the @code{slimit} register to set the maximum number of objects on
-the input stack. If @code{slimit} is less than or equal to@tie{}0,
-there is no limit set. With no limit, a buggy recursive macro can
-exhaust virtual memory.
-
-The default value is 1000; this is a compile-time constant.
+If greater than@tie{}0, sets the maximum quantity of objects on GNU
+@code{troff}'s internal input stack. If less than or equal to@tie{}0,
+there is no limit: recursion can continue until program memory is
+exhausted. The default value is 1000, fixed at compile time.
@endDefreg
@Defreq {warnscale, si}
diff --git a/man/groff.7.man b/man/groff.7.man
index cae0b6a..b3cc532 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -4948,12 +4948,21 @@ Right skip width from the center of the last glyph in
the
.esc w
argument.
.
+.
.TPx
.REG slimit
-If greater than 0, the maximum number of objects on the input stack.
+If >0,
+sets the maximum quantity of objects on
+.IR \%@g@troff 's
+internal input stack.
+.
+If \[<=]0,
+there is no limit:
+recursion can continue until program memory is exhausted.
+.
+The default is 1000,
+fixed at compile time.
.
-If \[<=]0 there is no limit, i.e., recursion can continue until virtual
-memory is exhausted.
.
.TPx
.REG ssc
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 4f38bd3..39984c9 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -4076,15 +4076,20 @@ The return value of the system() function executed by
the last
.B sy
request.
.
+.
.TP
.B \[rs]n[slimit]
-If greater than\~0, the maximum number of objects on the input stack.
+If greater than\~0,
+sets the maximum quantity of objects on
+.IR \%@g@troff 's
+internal input stack.
.
-If less than or equal to\~0, there is no limit on the number of
-objects on the input stack.
+If less than or equal to\~0,
+there is no limit:
+recursion can continue until program memory is exhausted.
.
-With no limit, recursion can continue until virtual memory is
-exhausted.
+The default value is 1000,
+fixed at compile time.
.
.
.TP
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 16/35: [docs]: Tweak discussion of \n[slimit].,
G. Branden Robinson <=