groff-commit
[Top][All Lists]
Advanced

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

[groff] 23/25: [docs]: Fix error in `rm`, `rr` request synopses.


From: G. Branden Robinson
Subject: [groff] 23/25: [docs]: Fix error in `rm`, `rr` request synopses.
Date: Sat, 4 Nov 2023 01:02:57 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 3f69bb20606f259b507782474873e291ff63620c
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Fri Nov 3 22:59:19 2023 -0500

    [docs]: Fix error in `rm`, `rr` request synopses.
    
    * doc/groff.texi (Setting Registers, Strings):
    * man/groff.7.man (Request short reference): Fix errors; the `rm` and
      `rr` requests take an arbitrary number of arguments.  Ossanna nroff
      and DWB nroff both behave this way.  Nor did CSTR #54, in its 1976 or
      1992 revisions, document this.  Problem appears to date back
      "forever", to the oldest revisions of these files in our Git
      repository.
---
 ChangeLog       | 10 ++++++++++
 doc/groff.texi  | 18 ++++++++++++++----
 man/groff.7.man | 13 ++++++++-----
 3 files changed, 32 insertions(+), 9 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 2221f21a5..edabe790e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2023-11-03  G. Branden Robinson <g.branden.robinson@gmail.com>
+
+       * doc/groff.texi (Setting Registers, Strings):
+       * man/groff.7.man (Request short reference): Fix errors; the
+       `rm` and `rr` requests take an arbitrary number of arguments.
+       Ossanna nroff and DWB nroff both behave this way.  Nor did CSTR
+       #54, in its 1976 or 1992 revisions, document this.  Problem
+       appears to date back "forever", to the oldest revisions of these
+       files in our Git repository.
+
 2023-11-03  G. Branden Robinson <g.branden.robinson@gmail.com>
 
        * src/roff/troff/env.cpp: Drop parameter names from prototypes,
diff --git a/doc/groff.texi b/doc/groff.texi
index 38fc64d3e..c3ce61b89 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -7616,13 +7616,18 @@ If a register's prior value does not exist (the 
register was undefined),
 an increment or decrement is applied as if to@tie{}0.
 @endDefreq
 
-@Defreq {rr, ident}
+@cindex CSTR@tie{}#54 errata
+@cindex CSTR@tie{}#54 erratum, @code{rr} request
+@Defreq {rr, reg @dots{}}
 @cindex removing a register (@code{rr})
 @cindex register, removing (@code{rr})
-Remove register @var{ident}.  If @var{ident} doesn't exist, the request
+Remove each register @var{reg}.  If @var{reg} doesn't exist, the request
 is ignored.  Technically, only the name is removed; the register's
 contents are still accessible under aliases created with @code{aln}, if
 any.
+
+This request is incorrectly documented in the @acronym{AT&T}
+@code{troff} manual accepting only one argument.
 @endDefreq
 
 @Defreq {rnn, ident1 ident2}
@@ -12684,7 +12689,9 @@ source document maintenance.)
 Rename the request, macro, diversion, or string @var{old} to @var{new}.
 @endDefreq
 
-@Defreq {rm, name}
+@cindex CSTR@tie{}#54 errata
+@cindex CSTR@tie{}#54 erratum, @code{rm} request
+@Defreq {rm, name @dots{}}
 @cindex removing request (@code{rm})
 @cindex request, removing (@code{rm})
 @cindex removing macro (@code{rm})
@@ -12693,9 +12700,12 @@ Rename the request, macro, diversion, or string 
@var{old} to @var{new}.
 @cindex string, removing (@code{rm})
 @cindex removing diversion (@code{rm})
 @cindex diversion, removing (@code{rm})
-Remove the request, macro, diversion, or string @var{name}.  GNU
+Remove each request, macro, diversion, or string @var{name}.  GNU
 @code{troff} treats subsequent invocations as if the name had never
 been defined.
+
+This request is incorrectly documented in the @acronym{AT&T}
+@code{troff} manual accepting only one argument.
 @endDefreq
 
 @anchor{als}
diff --git a/man/groff.7.man b/man/groff.7.man
index 9e2a62ccd..2b1ffb6ba 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -3961,8 +3961,11 @@ If
 stop right-aligning.
 .
 .TPx
-.REQ .rm "name"
-Remove request, macro, diversion, or string
+.REQ .rm "name \f[R].\|.\|."
+Remove each request,
+macro,
+diversion,
+or string
 .IR name .
 .
 .TPx
@@ -3981,9 +3984,9 @@ to
 .
 .
 .TPx
-.REQ .rr ident
-Remove register
-.IR ident .
+.REQ .rr "reg \f[R].\|.\|."
+Remove each register
+.IR reg .
 .
 .
 .TPx



reply via email to

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