gbranden pushed a commit to branch master
in repository groff.
commit f47ee85ec613ffc234ce902e861a41c81b793f71
Author: G. Branden Robinson <[email protected]>
AuthorDate: Mon Mar 24 16:24:32 2025 -0500
[doc,man]: Update debugging material.
Unmark the `pchar` request as "experimental". It's functional enough
now that I'm confident we'll want to keep it, even if we fiddle its
output format in future releases.
Sync wording between Texinfo and man pages where possible.
---
doc/groff.texi.in | 23 ++++++++++++++++-------
man/groff.7.man | 4 +++-
man/groff_diff.7.man | 50 ++++++++++++++++++++++++++++++++++----------------
3 files changed, 53 insertions(+), 24 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index d318f4a6e..166327c74 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -9090,8 +9090,8 @@ with a hyphenation code value of zero to it. For
example, @samp{.hcode
� $} removes the hyphenation code from @samp{�} (unless @samp{$} has
already been assigned a different one).
-The experimental @code{pchar} request may be helpful to troubleshoot
-hyphenation code assignments. @xref{Debugging}.
+The @code{pchar} request may be helpful to troubleshoot hyphenation code
+assignments. @xref{Debugging}.
@endDefreq
@Defreq {hpfcode, a b [c d] @dots{}}
@@ -17568,10 +17568,17 @@ GNU
emits a variety of error diagnostics
and supports several categories of warning;
the output of each category can be selectively enabled or suppressed.
-A trace of the
-formatter's input processing stack can be emitted when errors or
-warnings occur by means of GNU @code{troff}'s @option{-b} option, or
-produced on demand with the @code{backtrace} request. The @code{tm}
+A trace of the formatter's input processing stack
+can be emitted when errors or warnings occur
+by means of
+GNU
+@code{troff}'s @c GNU
+@option{-b}
+option,
+or produced on demand with the
+@code{backtrace}
+request.
+The @code{tm}
and related requests can be used to emit customized diagnostic messages
or for instrumentation while troubleshooting. The @code{ex} and
@code{ab} requests cause early termination with successful and error
@@ -17586,7 +17593,9 @@ and exceptions,
registers,
open streams,
and page location traps.
-Other requests disclose
+GNU
+@command{troff} @c GNU
+can also disclose
to the standard error stream
the internal properties and representations of
characters,
diff --git a/man/groff.7.man b/man/groff.7.man
index 3e7a48ab7..f54fd5163 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -4096,7 +4096,9 @@ Change the page number character used in titles
.REQ .pchar "c \fR\&.\|.\|.\&\fP"
Report,
to the standard error stream,
-information about each ordinary or special
+information about each ordinary,
+special,
+or indexed
.RI character\~ c .
.
A character defined by a request
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 0b6727c2d..ac73dbcb9 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -5721,13 +5721,22 @@ and
options of
.MR @g@troff @MAN1EXT@ .
.
-Backtraces can be automatically produced when errors or warnings occur
-(the
+.
+.\" BEGIN Keep (roughly) parallel with relevant material from groff.texi
+.\" node "Debugging".
+.P
+A trace of the formatter's input processing stack
+can be emitted when errors or warnings occur
+by means of
+GNU
+.I troff \" GNU
.B \-b
-option of
-.MR @g@troff @MAN1EXT@ )
-or generated on demand
-.RB ( backtrace ).
+option,
+or produced on demand with the
+.B \%backtrace
+request.
+.\" END Keep (roughly) parallel with relevant material from groff.texi
+.\" node "Debugging".
.
.
.P
@@ -5737,11 +5746,12 @@ also adds more flexible diagnostic output requests
and
.BR tm1 ).
.
-Examine more aspects of formatter state
-with requests that write lists of
-defined
-characters
-.RB ( pchar "; experimental);
+.\" BEGIN Keep (roughly) parallel with relevant material from groff.texi
+.\" node "Debugging".
+Examine the state of the formatter with requests that write lists of
+.\" Deliberate desync with Texinfo: this is groff_diff(7); AT&T troff
+.\" already had `pm`.
+defined \" names---macros, strings, and diversions---
colors
.RB ( pcolor ),
composite characters
@@ -5754,12 +5764,20 @@ registers
.RB ( pnr ),
open streams
.RB ( pstream ),
+and
page location traps
-.RB ( ptr ),
-and a list of output nodes corresponding to the pending input
-line
-.RB ( pline )
-to the standard error stream.
+.RB ( ptr ).
+.
+GNU
+.I troff \" GNU
+can also disclose
+to the standard error stream
+the internal properties and representations of
+characters,
+macros (and strings and diversions),
+and the list of output nodes corresponding to the pending input line.
+.\" END Keep (roughly) parallel with relevant material from groff.texi
+.\" node "Debugging".
.
.
.\" ====================================================================
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
