groff-commit
[Top][All Lists]
Advanced

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

[groff] 18/38: [docs]: Fix documentation errors.


From: G. Branden Robinson
Subject: [groff] 18/38: [docs]: Fix documentation errors.
Date: Mon, 3 Oct 2022 01:42:57 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit fa9d986aeec2b706760523a04773fdfd40e121d0
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Sep 28 18:35:42 2022 -0500

    [docs]: Fix documentation errors.
    
    * Character classes and special character identifiers share a name space
      as well.
    * Remove bogus elements of an example using comment escape sequences
      when escape sequences are disabled.
    * Replace incomplete list of object types that use identifiers with the
      term "identifiers", a topic already presented at length and cross
      referenced.
---
 doc/groff.texi  | 18 ++++++++----------
 man/groff.7.man |  5 +++--
 2 files changed, 11 insertions(+), 12 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index e73517972..94f7759e0 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -6385,14 +6385,15 @@ stream generally provokes an error diagnostic.
 @cindex macros, shared name space with strings and diversions
 @cindex strings, shared name space with macros and diversions
 @cindex diversions, shared name space with macros and strings
-Identifiers for requests, macros, strings, and diversions share a name
-space.  No other object types do.
+Identifiers for requests, macros, strings, and diversions share one name
+space; special characters and character classes another.  No other
+object types do.
 
 @Example
 .de xxx
 .  nop foo
 ..
-.
+@c . slack line for pagination management
 .di xxx
 bar
 .br
@@ -14906,11 +14907,11 @@ been already stored in the diversion (box) are not 
taken into account.
 
 @Example
 .\" Center text both horizontally and vertically.
+.\" Macro .(c starts centering mode; .)c terminates it.
 .
 .\" Disable the escape character with .eo so that we
 .\" don't have to double backslashes on the "\n"s.
 .eo
-.\" Macro .(c starts centering mode.
 .de (c
 .  br
 .  ev (c
@@ -14921,7 +14922,6 @@ been already stored in the diversion (box) are not 
taken into account.
 ..
 @endExample
 @Example
-.\" Macro .)c terminates centering mode.
 .de )c
 .  br
 .  ev
@@ -14937,7 +14937,6 @@ been already stored in the diversion (box) are not 
taken into account.
 .  rr @@s
 .  rm @@c
 ..
-.\" End of macro definitions; restore escape character.
 .ec
 @endExample
 @endDefreg
@@ -16779,10 +16778,9 @@ Workbench @code{troff}s.
 GNU @code{troff} does not allow the use of the escape sequences
 @code{\|}, @code{\^}, @code{\&}, @code{\@{}, @code{\@}},
 @code{\@key{SP}}, @code{\'}, @code{\`}, @code{\-}, @code{\_}, @code{\!},
-@code{\%}, and @code{\c} in names of strings, macros, diversions,
-registers, fonts, or environments; @acronym{AT&T} @code{troff} does.
-The @code{\A} escape sequence (@pxref{Identifiers}) may be helpful in
-avoiding use of these escape sequences in names.
+@code{\%}, and @code{\c} in identifiers; @acronym{AT&T} @code{troff}
+does.  The @code{\A} escape sequence (@pxref{Identifiers}) may be
+helpful in avoiding use of these escape sequences in names.
 
 @cindex adjustment to both margins, difference from @acronym{AT&T} @code{troff}
 @cindex rivers
diff --git a/man/groff.7.man b/man/groff.7.man
index 3a69c2a3d..430043b0c 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -1382,8 +1382,9 @@ or stream generally provokes an error diagnostic.
 Identifiers for requests,
 macros,
 strings,
-and diversions share a name
-space.
+and diversions share one name
+space;
+special characters and character classes another.
 .
 No other object types do.
 .\" END Keep (roughly) parallel with groff.texi node "Identifiers".



reply via email to

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