groff-commit
[Top][All Lists]
Advanced

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

[groff] 36/40: groff_mdoc(7): Revise "Conventions" section.


From: G. Branden Robinson
Subject: [groff] 36/40: groff_mdoc(7): Revise "Conventions" section.
Date: Mon, 12 Dec 2022 19:28:08 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 01a8321361f65df6d46080497322e33282ea65f6
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Dec 12 16:08:00 2022 -0600

    groff_mdoc(7): Revise "Conventions" section.
    
    Annotate a general vagueness in the presentation of the macros.
    
    Set references to the package's own macros with ".Pf . Ic \&Xx",
    following a suggestion from Ingo Schwarze.
---
 tmac/groff_mdoc.7.man | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/tmac/groff_mdoc.7.man b/tmac/groff_mdoc.7.man
index f752947c2..d2e0178e9 100644
--- a/tmac/groff_mdoc.7.man
+++ b/tmac/groff_mdoc.7.man
@@ -779,9 +779,11 @@ but
 .Sq Li ls Bq Ar file .
 .
 Consequently,
-a warning message is emitted for most commands if the first argument is
+a warning message is emitted for many commands if the first argument is
 itself a macro,
 since it cancels the effect of the preceding one.
+.\" XXX: I don't think it is made clear which macros eat only argument
+.\" and which ones eat until another macro is encountered. -- GBR
 .
 On rare occasions,
 you might want to format a word along with surrounding brackets as a
@@ -812,9 +814,9 @@ Explicit
 and
 .Fl offset
 arguments to the
-.Ql \&Bl
+.Pf . Ic \&Bl
 and
-.Ql \&Bd
+.Pf . Ic \&Bd
 macros are preferable.
 .
 .



reply via email to

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