gbranden pushed a commit to branch master
in repository groff.
commit 22b259c96531383927af725b1a2bff68e0eb70d0
Author: G. Branden Robinson <[email protected]>
AuthorDate: Fri May 1 03:24:57 2026 -0500
[doc,man]: Revise & resync .ne, .trunc reg stuff.
* Sprung diversion traps populate these registers, so say the latter are
affected by "vertical position traps", not "page location traps".
* Break Texinfo input lines in convenient places for roffing and
diffing.
---
doc/groff.texi.in | 53 ++++++++++++++++++++++++++++++++++++++--------------
man/groff_diff.7.man | 4 ++--
2 files changed, 41 insertions(+), 16 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 260e095b0..d53c17cd4 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -19099,25 +19099,50 @@ qux
@endExample
@Defreg {.ne}
-The read-only register @code{.ne} contains the amount of space that was
-needed in the last @code{ne} request that caused a trap to be sprung;
-it is useful in conjunction with the @code{.trunc} register. @xref{Page
-Control}. Since the @code{.ne} register is set only by traps, it
-doesn't make sense to interpolate it outside of macros called by traps.
+The read-only register
+@code{.ne}
+contains the amount of vertical space demanded by the most recent
+@code{ne}
+request that sprang a vertical position trap;
+it is useful in conjunction with the
+@code{.trunc}
+register;
+recall @ref{Page Control}.
+Since the
+@code{.ne}
+register is set only by traps,
+it doesn't make sense
+to interpolate it outside of macros called by traps.
@endDefreg
@Defreg {.trunc}
@cindex @code{ne} request, and the @code{.trunc} register
@cindex truncated vertical space register (@code{.trunc})
-A read-only register containing the amount of vertical space truncated
-from an @code{sp} request by the most recently sprung vertical
-position trap, or, if the trap was sprung by an @code{ne} request,
-minus the amount of vertical motion produced by the @code{ne}
-request. In other words, at the point a trap is sprung, it
-represents the difference of what the vertical position would have
-been but for the trap, and what the vertical position actually is.
-Since the @code{.trunc} register is set only by traps, it doesn't make
-sense to interpolate it outside of macros called by traps.
+The read-only register
+@code{.trunc}
+contains the amount of vertical space truncated
+from an
+@code{sp}
+request's argument
+@c ...but not a `sv` request's argument.
+by the most recently sprung vertical position trap,
+or,
+if the trap was sprung by an
+@code{ne}
+request,
+minus the amount of vertical motion produced by the
+@code{ne}
+request.
+In other words,
+at the point a trap is sprung,
+it represents the difference
+of what the vertical position would have been but for the trap,
+and what the vertical position actually is.
+Since the
+@code{.trunc}
+register is set only by traps,
+it doesn't make sense
+to interpolate it outside of macros called by traps.
@endDefreg
@Defreg {.trap}
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 02754a2dc..a668eed30 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -5312,7 +5312,7 @@ This is a string-valued register.
.B \[rs]n[.ne]
Interpolate amount of space demanded by the most recent
.B ne
-request that sprang a page location trap.
+request that sprang a vertical position trap.
.
See
.BR \[rs]n[.trunc] .
@@ -5449,7 +5449,7 @@ This is a string-valued register.
.TP
.B \[rs]n[.trunc]
Interpolate amount of vertical space truncated by the most recently
-sprung page location trap,
+sprung vertical position trap,
or,
if the trap was sprung by an
.B ne
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
