gbranden pushed a commit to branch master
in repository groff.
commit 960a1512c51458cd8bdce5189ba76e033c85bd8d
Author: G. Branden Robinson <[email protected]>
AuthorDate: Fri May 1 00:53:03 2026 -0500
[doc,man]: Revise and parallelize register stuff.
* Recast and parallelize language.
* Speak of "the formatter", not "GNU troff", when describing generally
applicable *roff behavior, and vice versa when describing groff
extensions.
* Cover what a non-degenerate request invocation does more fully before
talking about what a degenerate invocation does (nothing).
---
doc/groff.texi.in | 51 ++++++++++++++++++++++++++++++++++++++++-----------
man/groff_diff.7.man | 8 ++++++--
2 files changed, 46 insertions(+), 13 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index f8f42212e..5c7c6f8ae 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -9244,9 +9244,11 @@ or subtract the expression of interest from zero.
@result{} -3
@endExample
-If a register's prior value does not exist---the
-register was undefined---an increment or decrement is applied as if
-to@tie{}0.
+If
+@var{reg}
+is undefined,
+the formatter creates it
+and applies an increment or decrement to it as if to@tie{}0.
@endDefreq
@cindex CSTR@tie{}#54 errata
@@ -9254,10 +9256,22 @@ to@tie{}0.
@Defreq {rr, reg @dots{}}
@cindex removing a register (@code{rr})
@cindex register, removing (@code{rr})
-Remove each register @var{reg}. If @var{reg} doesn't exist, the request
-is ignored. Technically, only the name is removed; the register's
-contents are still accessible under aliases created with @code{aln}, if
-any.
+Remove each register
+@var{reg}.
+Technically,
+only the name is removed;
+the register's contents are still accessible
+under aliases created with
+@code{aln},
+if any.
+If
+@var{reg}
+is undefined,
+the formatter ignores the request.@footnote{GNU
+@command{troff} @c GNU
+emits a warning in category
+@samp{reg}.
+@xref{Warnings}.}
This request is incorrectly documented in the @acronym{AT&T}
@code{troff} manual as accepting only one argument.
@@ -9266,9 +9280,22 @@ This request is incorrectly documented in the
@acronym{AT&T}
@Defreq {rnn, ident1 ident2}
@cindex renaming a register (@code{rnn})
@cindex register, renaming (@code{rnn})
-Rename register @var{ident1} to @var{ident2}. If @var{ident1} doesn't
-exist, the request is ignored. Renaming a built-in register does not
-otherwise alter its properties.
+Rename register
+@var{ident1}
+to
+@var{ident2}.
+Renaming a built-in register
+does not otherwise alter its properties.
+If
+@var{ident1}
+is undefined,
+GNU
+@command{troff} @c GNU
+ignores the request.@footnote{GNU
+@command{troff} @c GNU
+emits a warning in category
+@samp{reg}.
+@xref{Warnings}.}
@endDefreq
@Defreq {aln, new-register existing-register}
@@ -9284,7 +9311,9 @@ causing the names to refer to the same stored object.
If
@var{existing-register}
is undefined,
-the formatter ignores the request.@footnote{GNU
+GNU
+@command{troff} @c GNU
+ignores the request.@footnote{GNU
@command{troff} @c GNU
emits a warning in category
@samp{reg}.
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index ae05b8948..af61bff5b 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -4330,10 +4330,14 @@ Rename register
to
.IR r2 .
.
+Renaming a built-in register
+does not otherwise alter its properties.
If
.I r1
-doesn't exist,
-the request is ignored.
+is undefined,
+GNU
+.I troff \" GNU
+ignores the request.
.
.
.br
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
