gbranden pushed a commit to branch master
in repository groff.
commit e17d7cc10c596596e4ecbee52aa180d60af485e9
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sat Mar 28 13:42:26 2026 -0500
[doc,man]: Clarify removal of read-only registers.
---
doc/groff.texi.in | 20 ++++++++++++++------
man/groff.7.man | 6 +++++-
man/groff_diff.7.man | 9 +++++++++
3 files changed, 28 insertions(+), 7 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index a5fe04878..088e06c06 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -9348,11 +9348,11 @@ Predefined registers whose identifiers start with a dot
are read-only.
Many are Boolean-valued, interpolating a true or false value testable
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
+@cindex removing a read-only register
+@cindex register, read-only, removing
+@cindex read-only register, removing
@strong{Caution:@:}
-Built-in registers are subject to removal like others;
+Read-only 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.
@@ -22291,7 +22291,15 @@ to behave in ways difficult to predict.
@node Other Differences
@subsection Other Differences
-@c BEGIN Keep in sync with groff_diff(7).
+@c BEGIN Keep in sync with "Other differences" section of groff_diff(7).
+In
+GNU
+@command{troff}, @c GNU
+read-only 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.
+
GNU
@command{troff} @c GNU
does not emit output if it has nothing to format.
@@ -22885,7 +22893,7 @@ at the end of input;
GNU
@command{troff} @c GNU
does not.
-@c END Keep in sync with groff_diff(7).
+@c END Keep in sync with "Other differences" section of groff_diff(7).
diff --git a/man/groff.7.man b/man/groff.7.man
index 53bda6e4c..cdc19b0ef 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -7138,12 +7138,16 @@ Predefined registers whose identifiers start with a dot
are read-only.
Many are Boolean-valued.
.
.
+.\" BEGIN Keep (roughly) parallel with beginning of section
+.\" "Other differences" in groff_diff(7).
.P
.I Caution:
-Built-in registers are subject to removal like others;
+Read-only 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.
+.\" END Keep (roughly) parallel with beginning of section
+.\" "Other differences" in groff_diff(7).
.
.
.P
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index bca7db258..b7a29b3eb 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -6567,6 +6567,15 @@ McIlroy referred to it as a \[lq]living fossil\[rq].]
.\" ====================================================================
.
.\" BEGIN Keep in sync with groff.texi node "Other Differences".
+In
+GNU
+.IR troff , \" GNU
+read-only 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.
+.
+.P
GNU
.I troff \" GNU
does not emit output if it has nothing to format.
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
