[groff] 01/05: doc/groff.texi: Tweak inter-sentence space matter.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit baf6b892ae220d0861585f4879bbf19860d686af
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue Dec 29 16:09:31 2020 +1100

    doc/groff.texi: Tweak inter-sentence space matter.
    
    * doc/groff.texi (Manipulating Filling and Adjustment) <.ss>: Update
      metasyntactic variable name to make clearer that the second parameter
      to the .ss request is _additional_ space.  Tighten wording.  Remove
      paragraph redundant with earlier material, and add cross reference to
      same.
    * man/groff_diff.7.man (Language/Extended requests) <.ss>: Resync with
      our Texinfo manual.
    
    Thanks to James K. Lowden, Peter Schaffter, Dave Kemper, and M. Douglas
    McIlroy for the discussion.
---
 doc/groff.texi       | 23 ++++++++++-------------
 man/groff_diff.7.man | 19 ++++---------------
 2 files changed, 14 insertions(+), 28 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 81cc6de..35dd7f6 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -6948,7 +6948,7 @@ This is an uninteresting sentence.
 @endExample
 @endDefreq
 
-@DefreqList {ss, word-space-size [@Var{sentence-space-size}]}
+@DefreqList {ss, word-space-size [@Var{additional-sentence-space-size}]}
 @DefregItemx {.ss}
 @DefregListEndx {.sss}
 @cindex word space size register (@code{.ss})
@@ -6958,11 +6958,13 @@ This is an uninteresting sentence.
 @cindex sentence space size register (@code{.sss})
 @cindex size of sentence space register (@code{.sss})
 @cindex space between sentences register (@code{.sss})
-Set the sizes of spaces between words and sentences.  Their units are
-twelfths of the space width parameter of the current font.  Initially
-both the @var{word-space-size} and @var{sentence-space-size}
-are@tie{}12.  Negative values are not permitted.  The request is ignored
-if there are no arguments.
+Set the sizes of spaces between words and
+sentences.@footnote{@xref{Filling} and @ref{Sentences} for the
+definitions of word and sentence boundaries, respectively.}  Their units
+are twelfths of the space width parameter of the current font.
+Initially both the @var{word-space-size} and
+@var{additional-sentence-space-size} are@tie{}12.  Negative values are
+not permitted.  The request is ignored if there are no arguments.
 
 @cindex inter-word spacing, minimal
 @cindex minimal inter-word spacing
@@ -6975,8 +6977,8 @@ automatically adjusted, it may increase.
 @cindex space, between sentences
 The optional second argument sets the amount of additional space
 separating sentences on the same output line in fill mode.  If the
-second argument is omitted, @var{sentence-space-size} is set to
-@var{word-space-size}.
+second argument is omitted, @var{additional-sentence-space-size} is set
+to @var{word-space-size}.
 
 The read-only registers @code{.ss} and @code{.sss} hold the values of
 minimal inter-word space and additional inter-sentence space,
@@ -6996,11 +6998,6 @@ Additional inter-sentence space is not adjusted, but the 
inter-word
 space that always precedes it may be.  Further input spaces after the
 second, if present, are adjusted as normal.
 
-If a second argument is never given to the @code{ss} request, GNU
-@code{troff} separates sentences as @acronym{AT&T} @code{troff} does.
-In input to GNU @code{troff}, as with @acronym{AT&T} @code{troff}, a
-sentence should always be followed by either a newline or two spaces.
-
 @cindex discardable horizontal space
 @cindex space, discardable, horizontal
 @cindex horizontal discardable space
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 508a8b2..d7f135c 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -3413,7 +3413,7 @@ and the latter enables hyphenation after the first 
character in a word.
 .
 .
 .TP
-.BI .ss\~ "word-space-size sentence-space-size"
+.BI .ss\~ "word-space-size additional-sentence-space-size"
 A second argument to the
 .B .ss
 request determines the additional inter-sentence spacing used in fill
@@ -3439,6 +3439,7 @@ instead,
 the values of minimal inter-word and additional inter-sentence spacing
 are rounded down to the nearest multiple of\~12.
 .
+.
 .IP
 Additional inter-sentence spacing is used only in fill mode,
 and only if the output line is not full when the end of a sentence
@@ -3454,20 +3455,6 @@ then the second space becomes an inter-sentence space in 
the output.
 Additional inter-sentence space is not adjusted,
 but the inter-word space that always precedes it may be.
 .
-.IP
-If a second argument is never given to the
-.B .ss
-request,
-.I groff
-separates sentences as
-.RI AT&T\~ troff
-does.
-.
-In
-.IR groff ,
-as in
-.RI AT&T\~ troff ,
-you should always follow a sentence with either a newline or two spaces.
 .
 .IP
 A related application of the
@@ -3491,6 +3478,7 @@ large spaces between each.
 .RE
 .RE
 .
+.
 .IP
 The result has obvious inter-sentence spacing.
 .RS
@@ -3503,6 +3491,7 @@ known for other work.
 .RE
 .RE
 .
+.
 .TP
 .BR .ta\~ [[\c
 .IR "n1 n2\~" .\|.\|.\~ nn \~]\c