[groff] 01/14: Fix clarity problems and doubled words.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit 7476112d35aa8478b1ec89c5b435817763b3bf80
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Jan 22 03:50:19 2022 +1100

    Fix clarity problems and doubled words.
    
    ...and some recent typos.
    
    * ChangeLog: Recast my own entry regarding a post-1.22.4 refactor of the
      man(7) font style alternation macros, for greater attempted clarity
      and more normative use of terminology.  Also be less vague about what
      'tty.tmac' does with the 'latin1' and 'cp1047' macro files.
    * ChangeLog.119, NEWS (1.06[!]): Fix doubled word typos.
    * ChangeLog: Fix recent typo "easile", extraneous phrase "not a
      warning", and inappropriate plural.
    
    I recognize that some people feel it is inappropriate to modify older
    content of ChangeLog and NEWS files in any way.  Permit me to paraphrase
    myself in response[1] to Ingo Schwarze.
    
    ---
    > changing historical information in the ChangeLog and the NEWS file
    > would be wrong.
    
    I agree that misrepresenting history would be wrong, but correcting
    solecisms like doubled words is not a misrepresentation of history--it's
    a _more accurate_ representation of history.
    
    Because my own brain hates me, it is only after committing and pushing
    that I am likely to notice egregiously bad typos or missing words in my
    ChangeLog entries.
    
    Material misrepresentations of fact in such files should either be
    corrected in-place or supplemented with "[recte: ]" or similar
    annotation.
    
    There is the question of how much time has to pass before we consider
    that such documents (or what portions of them, in the case of "NEWS")
    have stabilized such that the bracketed-annotation approach is more
    appropriate than the former.  The question does not arise in this case.
    
    Anyway, like you, I don't exactly welcome further use of the Savannah
    system for this sort of thing.  It would be better for such "linty"
    patches to go to the groff@ mailing list, and better still for someone
    to contribute a style checker that we can run automatically as part of
    builds to catch these things automatically so that a developer can fix
    them before they're even introduced into a pushed commit.
    
    What ever became of the Writer's Workbench, eh?
    
    As I recall, a doubled-word finder for plain text that works across line
    boundaries is an exercise in the O'Reilly _sed & awk_ book.  It would be
    a nice thing for a new developer to contribute!  :)
    ---
    
    [1] https://savannah.gnu.org/bugs/?51062
---
 ChangeLog     | 17 +++++++++--------
 ChangeLog.119 |  2 +-
 NEWS          |  8 ++++----
 3 files changed, 14 insertions(+), 13 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 39e6a96b..b4fa4c3f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -71,7 +71,7 @@
        the former name (or worse, we break it if we're loaded later).
        (pdfpic@error): Stop aborting; simply report an error.  It's up
        to the user how serious `PDFPIC` macro problems are.  As noted
-       in a comment, the user can easile `am PDFPIC` to tack an `ab`
+       in a comment, the user can easily `am PDFPIC` to tack an `ab`
        request onto the end of its definition.  Always report input
        file name and line number.  Replace "[PDFPIC]" prefix with the
        name of the macro file complaining, to make it easier for groff
@@ -106,7 +106,7 @@
 
        * src/preproc/tbl/table.cpp: Fix it.
        (NOP_NAME): Add new preprocessor symbol to construct name of
-       "nop" macro to be used as end macros for `ig` requests inside
+       "nop" macro to be used as end macro for `ig` requests inside
        macro definitions.
        (table::init_output, table::compute_expand_list,
        table::compute_separation_factor):
@@ -138,8 +138,8 @@
        tbl-preprocessed document can generate (1) occur when they are
        supposed to and (2) are appropriately suppressed by the
        "nowarn" and/or "nokeep" region options.  One of them is an
-       error, not a warning, and cannot be suppressed the former, but
-       _can_ be by "nokeep", which is arguably a bug (Savannah #61878).
+       error and cannot be suppressed by the former, but _can_ be by
+       "nokeep", which is arguably a bug (Savannah #61878).
 
        * src/preproc/tbl/tests/format-time-diagnostics-work.sh: Do it.
        * src/preproc/tbl/tbl.am (tbl_TEST): Run test.
@@ -319,7 +319,7 @@
 
        * tmac/tty-char.tmac: Drop redundant logic.  We don't need to
        source the `cp1047` or `latin1` files here; `troffrc` will
-       already have loaded `tty` for us, which already does so.
+       already have loaded `tty` for us, which loads whichever applies.
 
 2022-01-14  G. Branden Robinson <g.branden.robinson@gmail.com>
 
@@ -6210,9 +6210,10 @@
        compatibility mode.
        (RI, IR, IB, BI): Defer interpolation of the first argument to
        the while loop if there are at least two (like the existing RB,
-       BR).  This way the the font escape style names in the appendment
-       to `an-result` match the order of the letters in the macro name
-       {useful to make sense of diffs}.
+       BR).  This way the style name arguments to the font selection
+       escape sequences in the appendment to `an-result` match the
+       order of the letters in the macro name (useful to make sense of
+       diffs).
        (RI, IR, IB, BI, RB, BR): Always remove the `an-result` string
        after interpolating it.
        (RB, BR): Only do work if there are any arguments.
diff --git a/ChangeLog.119 b/ChangeLog.119
index 71915bc6..7e0345bb 100644
--- a/ChangeLog.119
+++ b/ChangeLog.119
@@ -3077,7 +3077,7 @@ Version 1.19.1 released
        * src/preproc/refer/ref.cpp (reference::compute_sort_key): Always
        insert SORT_SEP.  With certain combinations of sort specifications,
        refer sorted entries in the wrong order.  In particular, entries
-       with a missing field should be be sorted before all entries that
+       with a missing field should be sorted before all entries that
        have that field, before refer looks to the next field.
 
 2003-08-23  Werner LEMBERG  <wl@gnu.org>
diff --git a/NEWS b/NEWS
index 64fc0305..bf28bf07 100644
--- a/NEWS
+++ b/NEWS
@@ -2795,10 +2795,10 @@ not work with low resolution devices such as -TX75 and 
-TX100.  However,
 this caused problems with existing -me documents.  In this release, the
 vertical spacing is controlled by the $v and $V registers which have the
 same meaning as $r and $R in earlier groff releases.  In addition, if
-the $r or $R register is set to a value that would be correct for for
-the BSD -me macros and a low resolution device is not being used, then
-an appropriate value for the $v or $V register is derived from the $r or
-$R register.
+the $r or $R register is set to a value that would be correct for the
+BSD -me macros and a low resolution device is not being used, then an
+appropriate value for the $v or $V register is derived from the $r or $R
+register.
 
 The groff -me macros work with -C and (I think) with Unix troff.