discuss@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: "Paul A. Patience" <paul@apatience.com>
To: discuss@mandoc.bsd.lv
Subject: Re: Proper Macro for Types
Date: Sat, 12 Mar 2022 01:49:17 +0000	[thread overview]
Message-ID: <87ilsk55ki.fsf@apatience.com> (raw)


Hi Robert,

> For types which are not directly related to a function or variable, in
> illumos we've been using .Vt. Is this correct? If not, what is the right
> macro to use? Either way could we perhaps add a statement to mdoc(7)
> about the right macro to use for this? The statement regarding .Fa has
> been very helpful and makes it quite clear what to do.

I would say .Vt is correct.
Some examples:

- elf(3): .Vt Elf, etc.
- timeradd(3): .Vt struct timeval
- CMS_add1_signer(3): .Vt SignedData, .Vt CMS_SignerInfo

However, there are inconsistencies (which we could term errors in light
of the above examples):

- clock_gettime(2): .Dv timespec
- ctime(3): .Li tm
- getnameinfo(3): .Li sockaddr (and sockaddr_in, sockaddr_in6)
- radio(4): .Fa "struct radio_info"
  (though seeing “.Fa int” above it makes me think it's being treated as
  the argument to ioctl)

I also found an unquestionable error in the elf(3) series of man pages:
They use .Ar rather than .Fa for function arguments (for example in
elf_flagdata(3)).

Best regards,
Paul

--
 To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv


             reply	other threads:[~2022-03-12  1:49 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-12  1:49 Paul A. Patience [this message]
  -- strict thread matches above, loose matches on Subject: below --
2022-01-29 17:12 Robert Mustacchi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87ilsk55ki.fsf@apatience.com \
    --to=paul@apatience.com \
    --cc=discuss@mandoc.bsd.lv \
    --subject='Re: Proper Macro for Types' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).