summaryrefslogtreecommitdiff
path: root/tmac/groff_mdoc.7.man
diff options
context:
space:
mode:
authorG. Branden Robinson <g.branden.robinson@gmail.com>2022-12-12 16:08:00 -0600
committerG. Branden Robinson <g.branden.robinson@gmail.com>2022-12-12 18:16:09 -0600
commit01a8321361f65df6d46080497322e33282ea65f6 (patch)
tree4ccef670c88142ad0fdde87266ac304e06448479 /tmac/groff_mdoc.7.man
parent4beea88ea87d577c74e93debf4129aeb46dc6707 (diff)
downloadgroff-git-01a8321361f65df6d46080497322e33282ea65f6.tar.gz
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.
Diffstat (limited to 'tmac/groff_mdoc.7.man')
-rw-r--r--tmac/groff_mdoc.7.man8
1 files 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.
.
.