gbranden pushed a commit to branch master
in repository groff.
commit ed165276b6959dcd69c182fee234c2069cd535d0
Author: G. Branden Robinson <[email protected]>
AuthorDate: Wed Apr 29 11:50:02 2026 -0500
doc/groff.texi.in: Fix Savannah #68287.
Explicitly call-out read-only registers as such.
Most already were; gather up the stragglers.
.$ already
.A no @Defesc{}; in table; table preamble updated
.C already
.F no @Defesc{}; in table; table preamble updated
.H already
.L already
.M already
.O DONE
.P no @Defesc{}; in table; table preamble updated
.R no @Defesc{}; in table; table preamble updated
.T no @Defesc{}; in table; table preamble updated
.U no @Defesc{}; in table; table preamble updated
.V already
.Y no @Defesc{}; in table; table preamble updated
.a already
.b already
.br already
.c no @Defesc{}; in table; table preamble updated
.cdp DONE
.ce already
.cht DONE
.color already
.cp already
.csk DONE
.d already
.ev already
.f already
.fam already
.fn already
.fp already
.g no @Defesc{}; in table; table preamble updated
.h already
.height already
.hla already
.hlc already
.hlm already
.hy already
.hydefault already
.hym already
.hys already
.i already
.in already
.int DONE
.it already
.itc already
.itm already
.j already
.k already
.kern already
.l already
.lg already
.linetabs already
.ll already
.lt already
.m already
.n DONE
.ne already
.nm DONE
.nn DONE
.ns already
.o already
.p already
.pe already
.pn already
.ps already
.psr already
.pvs already
.rj already
.s already
.slant already
.sr already
.ss already
.sss already
.sty already
.t already
.tabs already
.trap already
.trunc already
.u already
.ul already
.v already
.vpt already
.w DONE
.warn already
.x no @Defesc{}; in table; table preamble updated
.y no @Defesc{}; in table; table preamble updated
.z already
.zoom already
Fixes <https://savannah.gnu.org/bugs/?68287>. Thanks to Dave
Kemper for the report.
---
ChangeLog | 11 +++++++++
doc/groff.texi.in | 72 +++++++++++++++++++++++++++++++++++++++----------------
2 files changed, 63 insertions(+), 20 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index c47e674f2..0a5c21718 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+2026-04-29 G. Branden Robinson <[email protected]>
+
+ * doc/groff.texi.in: Explicitly call out read-only registers as
+ such. Most already were; gather up the stragglers: `.O`,
+ `.cdp`, `.cht`, `.csk`, `.int`, `.n`, `.nm`, `.nn`, and `.w`.
+ (Built-in Registers): Accordingly annotate the table of such
+ registers whose values are fixed at formatter start-up.
+
+ Fixes <https://savannah.gnu.org/bugs/?68287>. Thanks to Dave
+ Kemper for the report.
+
2026-04-27 G. Branden Robinson <[email protected]>
* src/roff/troff/reg.cpp: Slightly refactor. Tweak and make
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 115b95b43..c92ac77c7 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -9653,6 +9653,7 @@ GNU
@command{troff}, @c GNU
or obtain information about its command-line options
or processing progress.
+All are read-only.
@table @code
@item \n[.A]
@@ -12053,7 +12054,7 @@ flushing out the pending output line in the usual way.
@cindex interrupted line register (@code{.int})
@cindex continued output line register (@code{.int})
-The @code{.int} register interpolates a positive value
+The @code{.int} read-only register interpolates a positive value
only if the pending output line has been continued with
@code{\c};
this datum is associated
@@ -15186,7 +15187,8 @@ before the last call to @code{pvs}. GNU @code{troff}
emits a warning in
category @samp{range} if @var{space} is negative; the post-vertical
spacing is then set to zero.
-The read-only register @code{.pvs}
+The read-only register
+@code{.pvs}
interpolates the post-vertical spacing.
@endDefreq
@@ -18079,9 +18081,14 @@ updated as each line is output, even if no line number
is formatted with
it because it is being skipped (it is not a multiple of @var{increment})
or because numbering is suppressed (see the @code{nn} request below).
-The @code{.nm} register tracks the enablement status of numbering.
-Temporary suspension of numbering with the @code{nn} request does
-@emph{not} alter its value.
+The
+@code{.nm}
+read-only register tracks the enablement status of numbering.
+Temporary suspension of numbering with the
+@code{nn}
+request does
+@emph{not}
+alter its value.
@Example
.po 5n
@@ -18136,8 +18143,10 @@ lines once
@code{nm}
enables it.
-The @code{.nn} register stores the
-count of lines remaining in the environment
+The
+@code{.nn}
+read-only register
+stores the count of lines remaining in the environment
for which numbering is suppressed
while output line numbering is enabled.
@@ -20336,19 +20345,36 @@ Copying an environment to itself discards the
foregoing data.
@cindex skew, of last glyph (@code{.csk})
@cindex last glyph, dimensions (@code{.w}, @code{.cht}, @code{.cdp},
@code{.csk})
@cindex glyph, last, dimensions (@code{.w}, @code{.cht}, @code{.cdp},
@code{.csk})
-The @code{\n[.w]} register contains the width of the last glyph
-formatted in the environment.
+The
+@code{\n[.w]}
+read-only register contains the width of the last glyph
+formatted in the environment.@footnote{This quantity
+is also known as the
+@slanted{advance width};
+recall the
+@code{cs}
+request description in @ref{Artificial Fonts}.}
-The @code{\n[.cht]} register contains the height of the last glyph
+The
+@code{\n[.cht]}
+read-only register contains the height of the last glyph
formatted in the environment.
-The @code{\n[.cdp]} register contains the depth of the last glyph
-formatted in the environment. It is positive for glyphs extending below
-the baseline.
+The
+@code{\n[.cdp]}
+read-only register contains the depth of the last glyph
+formatted in the environment.
+It is positive for glyphs extending below the baseline.
-The @code{\n[.csk]} register contains the @dfn{skew} (how far to the
-right of the glyph's center that GNU @code{troff} should place an
-accent) of the last glyph formatted in the environment.
+The
+@code{\n[.csk]}
+read-only register contains the
+@dfn{skew}
+(how far to the right of the glyph's center that
+GNU
+@command{troff}
+should place an accent)
+of the last glyph formatted in the environment.
@endDefreg
@Defreg {.n}
@@ -20356,8 +20382,10 @@ accent) of the last glyph formatted in the environment.
@cindex line length, previous (@code{.n})
@cindex length of previous line (@code{.n})
@cindex previous line length (@code{.n})
-The @code{\n[.n]} register contains the length of the previous output
-line emitted in the environment.
+The
+@code{\n[.n]}
+read-only register contains the length
+of the output line most recently formatted in the environment.
@endDefreg
@codequotebacktick off
@@ -20457,8 +20485,12 @@ the next image.
@cindex suppression nesting level register (@code{.O})
@cindex nesting level, suppression, register (@code{.O})
@cindex level, suppression nesting, register (@code{.O})
-Output suppression nesting level applied by @code{\O3} and @code{\O4}
-escape sequences.
+The output suppression nesting level applied by
+@code{\O3}
+and
+@code{\O4}
+is available in the read-only register
+@samp{.O}.
@endDefreg
@c =====================================================================
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
