gbranden pushed a commit to branch master
in repository groff.
commit d180bc45c5878df16eddd4f9a57d4523e8727c75
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sat Mar 22 17:37:58 2025 -0500
[doc,man]: Fix content and style nits.
* Clarify that the auto-incrementation applies only to user-defined
registers.
* Favor active voice over passive.
* Parallelize input line breaks (where possible).
---
doc/groff.texi.in | 24 ++++++++++++++++--------
man/groff.7.man | 29 ++++++++++++++---------------
2 files changed, 30 insertions(+), 23 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 03f588f65..510061ac1 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -7775,11 +7775,17 @@ value is interpolated, and a warning in category
@samp{reg} is emitted.
@cindex incrementation, automatic, of a register
@cindex decrementation, automatic, of a register
-Registers can also be incremented or decremented by a configured amount
-at the time they are interpolated. The value of the increment is
-specified with a third argument to the @code{nr} request, and a special
-interpolation syntax is used to alter and then retrieve the register's
-value. Together, these features are called
+User-defined registers can also be incremented or decremented
+by a configured amount
+at the time they are interpolated.
+The value of the increment is specified with a third argument to the
+@code{nr}
+request,
+and a special interpolation syntax
+@c XXX: Texinfo 5.0 doesn't have a command for the � glyph.
+alters and then retrieves the register's value.
+Together,
+these features are called
@dfn{auto-increment}.@footnote{A negative auto-increment can be
considered an ``auto-decrement''.}
@@ -7967,9 +7973,11 @@ with the @code{if}, @code{ie}, or @code{while} requests.
@cindex removing a built-in register
@cindex register, built-in, removing
@cindex built-in register, removing
-@strong{Caution:@:} Built-in registers are subject to removal like
-others; once removed, they can be recreated only as normal writable
-registers and will not reflect the configuration of the formatter.
+@strong{Caution:@:}
+Built-in registers are subject to removal like others;
+once removed,
+they can be recreated only as normal writable registers
+and will not otherwise reflect the configuration of the formatter.
A register name is often associated with a request of the same name
(without the dot). A complete listing of all built-in registers can be
diff --git a/man/groff.7.man b/man/groff.7.man
index 89bd4cf43..027c1c2e3 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -6468,7 +6468,8 @@ escape sequence.
.
.
.P
-Registers can also be incremented or decremented by a configured amount
+User-defined registers can also be incremented or decremented
+by a configured amount
at the time they are interpolated.
.
The value of the increment is specified with a third argument to the
@@ -6477,8 +6478,7 @@ request,
and a special interpolation syntax,
.BI \[rs]n \[+-]\c
,
-is used to alter and then retrieve
-the register's value.
+alters and then retrieves the register's value.
.
Together,
these features are called
@@ -6491,24 +6491,23 @@ considered an \[lq]auto-decrement\[rq].)
.P
Many predefined registers are available.
.
-In the following presentation,
-the register interpolation syntax
+The following presentation uses
+register interpolation syntax
.BI \[rs]n[ name ]
-is used to refer to a register
+to refer to a register
.I name
to clearly distinguish it from a string or request
-.IR name .
+.IR name ;
+the symbols
+.B \[rs]n[]
+are
+.I not
+part of the register name.
.
The register name space is separate from that used for requests,
macros,
strings,
and diversions.
-.
-The symbols
-.B \[rs]n[]
-are
-.I not
-part of the register name.
.\" END Keep (roughly) parallel with groff.texi node "Registers".
.
.
@@ -6525,8 +6524,8 @@ Many are Boolean-valued.
.I Caution:
Built-in registers are subject to removal like others;
once removed,
-they can be recreated only as normal writable registers and will not
-reflect the configuration of the formatter.
+they can be recreated only as normal writable registers
+and will not otherwise reflect the configuration of the formatter.
.
.
.P
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
