groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 08/14: [ms]: Tighten wording in docs.


From: G. Branden Robinson
Subject: [groff] 08/14: [ms]: Tighten wording in docs.
Date: Fri, 20 Jan 2023 15:05:18 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 9f8464418f193230a9bbf121be587a09fdf878b0
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Jan 18 13:20:40 2023 -0600

    [ms]: Tighten wording in docs.
---
 doc/groff.texi      | 19 +++++++++----------
 doc/ms.ms           | 35 ++++++++++++++++-------------------
 tmac/groff_ms.7.man | 36 ++++++++++++++++--------------------
 3 files changed, 41 insertions(+), 49 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index d4179a767..abbffc5fb 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -26,7 +26,7 @@
 @copying
 This manual documents GNU @code{troff} version 1.23.0.
 
-Copyright @copyright{} 1994--2022 Free Software Foundation, Inc.
+Copyright @copyright{} 1994--2023 Free Software Foundation, Inc.
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
@@ -468,7 +468,7 @@ developing GNU and promoting software freedom.''
 @title groff
 @subtitle The GNU implementation of @code{troff}
 @subtitle Edition 1.23.0
-@subtitle December 2022
+@subtitle January 2023
 @author Trent@tie{}A.@: Fisher
 @author Werner Lemberg
 @author G.@tie{}Branden Robinson
@@ -4215,9 +4215,9 @@ the first, and produces no footers.  You can customize 
this arrangement.
 There are multiple ways to produce headers and footers.  One is to
 define the strings @code{LH}, @code{CH}, and @code{RH} to set the left,
 center, and right headers, respectively; and @code{LF}, @code{CF}, and
-@code{RF} to set the left, center, and right footers similarly.  This
-approach works best for documents that do not distinguish odd- and
-even-numbered pages.
+@code{RF} to set the left, center, and right footers.  This approach
+suffices for documents that do not distinguish odd- and even-numbered
+pages.
 
 Another method is to call macros that set headers or footers for odd- or
 even-numbered pages.  Each such macro takes a delimited argument
@@ -4503,7 +4503,7 @@ report errors, rather than silently to ignore them.
 
 @item
 Tenth Edition @c possibly 9th
-Research Unix supported @code{P1} and @code{P2} macros for setting code
+Research Unix supported @code{P1}/@code{P2} macros to bracket code
 examples; @code{groff} @file{ms} does not.
 
 @item
@@ -4528,8 +4528,8 @@ headings, and displays, cause a reset of paragraph 
rendering parameters,
 and may change the indentation; they do so not by incrementing or
 decrementing it, but by setting it absolutely.  This can cause problems
 for documents that define additional macros of their own that try to
-manipulate indentation.  The solution is to use, not the @code{in}
-request, but the @file{ms} @code{RS} and @code{RE} macros.
+manipulate indentation.  Use the @file{ms} @code{RS} and @code{RE}
+macros instead of the @code{in} request.
 
 @item
 @cindex fractional type sizes in @file{ms} macros
@@ -4590,8 +4590,7 @@ space between columns, not the fixed gutter width of 
@acronym{AT&T}
 
 @item
 The @acronym{AT&T} @file{ms} manual did not document the @code{QI}
-register, whereas Berkeley did; @code{groff} @file{ms} accordingly
-supports it.
+register; Berkeley and @code{groff} @file{ms} do.
 @end itemize
 
 @Defmpreg {GS, ms}
diff --git a/doc/ms.ms b/doc/ms.ms
index 341c0451c..982fac3ac 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -22,8 +22,8 @@
 .nr TC-MARGIN \w'00' \" expect 2-digit page numbers at most
 .ie t .nr PI 3.5n
 .el   .nr PI 4n
-.ND December 2022
-.EH '%''December 2022'
+.ND January 2023
+.EH '%''January 2023'
 .EF ''''
 .OH 'Using \f[I]groff\f[] with the \f[I]ms\f[] macros''%'
 .OF ''''
@@ -3137,9 +3137,9 @@ and
 .CW RF
 to set the left,
 center,
-and right footers similarly.
+and right footers.
 .
-This approach works best for documents that do not distinguish odd- and
+This approach suffices for documents that do not distinguish odd- and
 even-numbered pages.
 .
 .
@@ -3881,10 +3881,9 @@ rather than silently to ignore them.
 .PP
 Tenth Edition \" possibly 9th
 Research Unix supported
-.B P1
-and
+.B P1 /
 .B P2
-macros for setting code examples;
+macros to bracket code examples;
 .I groff ms
 does not.
 .
@@ -3943,14 +3942,13 @@ but by setting it absolutely.
 This can cause problems for documents that define additional macros of
 their own that try to manipulate indentation.
 .
-The solution is to use,
-not the
-.CW in
-request,
-but
+Use
 .CW .RS
 and
-.CW .RE .
+.CW .RE
+instead of the
+.CW in
+request.
 .
 .
 .PP
@@ -3978,9 +3976,8 @@ Register values are converted to and stored as basic 
units.
 .
 See \[lq]Measurements\[rq] in the
 .I groff
-Texinfo manual or the
-.I groff (7)
-man page.
+Texinfo manual or in
+.I groff (7).
 .FE
 .
 This threshold makes use of a scaling unit with these parameters
@@ -4110,10 +4107,10 @@ The AT&T
 .I ms
 manual did not document the
 .CW QI
-register,
-whereas Berkeley did;
+register;
+Berkeley and
 .I "groff ms"
-accordingly supports it.
+do.
 .
 .
 .PP
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index db6896bc5..4fbe8e26c 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -10,7 +10,7 @@ manuscript macro package for formatting documents
 .\" Legal Terms
 .\" ====================================================================
 .\"
-.\" Copyright (C) 1989-2022 Free Software Foundation, Inc.
+.\" Copyright (C) 1989-2023 Free Software Foundation, Inc.
 .\"
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
@@ -1828,9 +1828,9 @@ and
 .B RF
 to set the left,
 center,
-and right footers similarly.
+and right footers.
 .
-This approach works best for documents that do not distinguish odd- and
+This approach suffices for documents that do not distinguish odd- and
 even-numbered pages.
 .
 .
@@ -2309,11 +2309,9 @@ rather than silently to ignore them.
 .
 .IP \[bu]
 Tenth Edition \" possibly 9th
-Research Unix supported a pair of
-.B P1
-and
-.B P2
-macros for setting code examples;
+Research Unix supported
+.BR P1 / P2
+macros to bracket code examples;
 .I groff ms
 does not.
 .
@@ -2372,14 +2370,13 @@ but by setting it absolutely.
 This can cause problems for documents that define additional macros of
 their own that try to manipulate indentation.
 .
-The solution is to use,
-not the
-.B in
-request,
-but
+Use
 .B .RS
 and
-.BR .RE .
+.B .RE
+instead of the
+.B in
+request.
 .
 .
 .IP \[bu]
@@ -2408,9 +2405,8 @@ units.
 .
 See \[lq]Measurements\[rq] in the
 .I groff
-Texinfo manual or the
-.MR groff @MAN7EXT@
-man page.)
+Texinfo manual or in
+.MR groff @MAN7EXT@ ).
 .
 This threshold makes use of a scaling unit with these parameters
 practical for high-resolution devices while preserving backward
@@ -2537,10 +2533,10 @@ The AT&T
 .I ms
 manual did not document the
 .B QI
-register,
-whereas Berkeley did;
+register;
+Berkeley and
 .I "groff ms"
-accordingly supports it.
+do.
 .
 .
 .IP \[bu]



reply via email to

[Prev in Thread] Current Thread [Next in Thread]