gbranden pushed a commit to branch master
in repository groff.
commit 180b5bcbdd775fb49207e635c2659aa85a267386
Author: G. Branden Robinson <[email protected]>
AuthorDate: Thu Sep 26 22:27:03 2024 -0500
doc/groff.texi.in: Clarify `\!`/`output` caution.
---
doc/groff.texi.in | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index bd274003f..4daf82e15 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -15746,9 +15746,15 @@ neutral double quote in the argument is stripped,
allowing embedded
leading spaces in @var{contents}, which is read in copy mode and
continues to the end of the input line.
-Use with caution! It is normally only needed for mark-up used by a
-postprocessor that does something with the output before sending it to
-the output device, filtering out @var{contents} again.
+@strong{Caution:@:} Use of these features can put syntactically invalid
+content into GNU @command{troff}'s output, which @code{groff}'s output
+drivers then fail to process. They are normally needed only for
+instructions to a postprocessor that does something with the output
+before sending it to the output device, filtering out @var{contents}
+again.
+@c TODO: Once the dust settles from Savannah #63074, document how these
+@c can be used to construct device extension commands without special
+@c character processing.
@endDefreq
@Defreq {asciify, div}
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
