gbranden pushed a commit to branch master
in repository groff.
commit fc2c877a9b99fd9a9a52ee12ca8cee9369216bb3
Author: G. Branden Robinson <[email protected]>
AuthorDate: Thu Nov 21 12:42:15 2024 -0600
doc/groff.texi.in: Clarify `so` newline reading.
---
doc/groff.texi.in | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 08ac68dcb..8d5a738af 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -16266,10 +16266,12 @@ of a book to be kept in a separate file. However,
files interpolated
with @code{so} are not preprocessed; to overcome this limitation, see
the @cite{gsoelim@r{(1)}} man page.
-Since GNU @code{troff} replaces the entire control line with the
-contents of a file, it matters whether @var{file} is terminated with a
-newline or not. Consider a file @file{xxx} containing only the word
-@samp{foo} without a trailing newline.
+@strong{Caution:@:} Since GNU @code{troff} replaces the entire control
+line with the contents of a file, @var{file} must end with a newline, or
+the formatter will continue reading the next input line of the
+@code{roff} file as if were part of the last line of the sourced file.
+Consider a file @file{xxx} containing only the word @samp{foo} without a
+trailing newline.
@Example
$ printf 'foo' > xxx
@@ -16297,8 +16299,8 @@ It is an error to use this request in safer mode, which
is the
default. Invoke GNU @code{troff} or a front end with the @option{-U}
option to enable unsafe mode.
-The comment regarding a final newline for the @code{so} request is valid
-for @code{pso} also.
+The cautionary note regarding a final newline for the @code{so} request
+applies to @code{pso} as well.
@endDefreq
@DefreqList {mso, [@code{"}]@Var{file}}
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
