groff-commit
[Top][All Lists]
Advanced

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

[groff] 18/32: groff_mdoc(7): Fix content nits.


From: G. Branden Robinson
Subject: [groff] 18/32: groff_mdoc(7): Fix content nits.
Date: Wed, 30 Nov 2022 07:26:05 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit b11edc15bd8c539e3659c5a0cb4c7369757694d8
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue Nov 29 05:30:44 2022 -0600

    groff_mdoc(7): Fix content nits.
    
    * (Dt): Clarify how prefixing a man section number with `\&` is handled.
    * (Dt): Migrate tbl(1) table illustrating examples from using a vertical
      rule; this will lay out ugly on terminal devices (Savannah #62471).
      Instead use the arrow notation already coming into use.  Adjust column
      spacing to help ensure a fit on 78-column terminals and to better
      match the way `It` items render.
    * (Xr): Clarify that it is the topic, not the section number, that is
      set in italics.
    * Recast claims for clearer and more accurate scoping.
---
 tmac/groff_mdoc.7.man | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/tmac/groff_mdoc.7.man b/tmac/groff_mdoc.7.man
index e07e817d9..f9bd8e0fb 100644
--- a/tmac/groff_mdoc.7.man
+++ b/tmac/groff_mdoc.7.man
@@ -219,10 +219,8 @@ but
 .Em not
 tabs.
 .
-The dot at the beginning of the line prepares
-.Tn GNU
-.Xr @g@troff
-to expect a macro name.
+The dot at the beginning of the line prepares the formatter to expect a
+macro name.
 .
 A dot followed immediately by a newline is ignored;
 this is called the
@@ -249,8 +247,8 @@ their interpretation by
 .
 .
 .Pp
-Macros in
-.Xr groff
+Macros in GNU
+.Xr troff
 accept an unlimited number of arguments,
 in contrast to other
 .Xr troff Ns No s
@@ -987,7 +985,8 @@ are shown below.
 .
 Observe how
 .Ql \[rs]&
-prevents the digit\~2 from being treated as a manual section number.
+prevents the numeral\~2 from being used to look up a predefined section
+name.
 .
 .
 .Pp
@@ -996,12 +995,12 @@ prevents the digit\~2 from being treated as a manual 
section number.
 .Bd -unfilled -offset 2n
 .TS
 tab(@);
-Lf(CR) | L C R.
-\&.Dt foo 2@foo(2)@System Calls Manual@foo(2)
-\&.Dt foo 2 m68k@foo(2)@m68k System Calls Manual@foo(2)
-\&.Dt foo 2 baz@foo(2)@System Calls Manual@foo(2)
-\&.Dt foo \[rs]&2 baz@foo(2)@baz@foo(2)
-\&.Dt foo \[dq]\[dq] baz@foo@baz@foo
+Lf(CR)1 L2 L C R.
+\&.Dt foo 2@\[->]@foo(2)@System Calls Manual@foo(2)
+\&.Dt foo 2 m68k@\[->]@foo(2)@m68k System Calls Manual@foo(2)
+\&.Dt foo 2 baz@\[->]@foo(2)@System Calls Manual@foo(2)
+\&.Dt foo \[rs]&2 baz@\[->]@foo(2)@baz@foo(2)
+\&.Dt foo \[dq]\[dq] baz@\[->]@foo@baz@foo
 .TE
 .Ed
 .
@@ -2265,7 +2264,8 @@ including a second argument for the section number 
enables them to be
 hyperlinked.
 .
 By default,
-these are set in italics to avoid cluttering the page with boldface.
+cross-referenced topics are set in italics to avoid cluttering the page
+with boldface.
 .
 .
 .Pp



reply via email to

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