From mboxrd@z Thu Jan  1 00:00:00 1970
X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on inbox.vuxu.org
X-Spam-Level: 
X-Spam-Status: No, score=0.2 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED,
	T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no version=3.4.4
Received: (qmail 15505 invoked from network); 12 Mar 2022 01:49:32 -0000
Received: from bsd.lv (HELO mandoc.bsd.lv) (66.111.2.12)
  by inbox.vuxu.org with ESMTPUTF8; 12 Mar 2022 01:49:32 -0000
Received: from fantadrom.bsd.lv (localhost [127.0.0.1])
	by mandoc.bsd.lv (OpenSMTPD) with ESMTP id 8cd606fa
	for <ml@inbox.vuxu.org>;
	Fri, 11 Mar 2022 20:49:29 -0500 (EST)
Received: from mail-40136.proton.ch (mail-40136.proton.ch [185.70.40.136])
	by mandoc.bsd.lv (OpenSMTPD) with ESMTP id 50f67e6a
	for <discuss@mandoc.bsd.lv>;
	Fri, 11 Mar 2022 20:49:29 -0500 (EST)
Date: Sat, 12 Mar 2022 01:49:17 +0000
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=apatience.com;
	s=protonmail2; t=1647049766;
	bh=L9CFH/KSMkqCmVFY5WREY5lQWdtl6IKOqp4zOB24jGE=;
	h=Date:To:From:Reply-To:Subject:Message-ID:From:To:Cc:Date:Subject:
	 Reply-To:Feedback-ID:Message-ID;
	b=HzcLHLZpFH1BqCFy346/3JO2Woo0LdmEM3KfLVow6Q8HqLeVZUAKZKMEB793uQJVT
	 mNYEugoMCL81vrTzAXO0T3X/1feXr5T4WNmpUVGwhRB3XfdEVAJguo8VcsWeoc8qQr
	 eBLLtwWnpjns0xITRqnXjRYWDqJcL4x89vPUtdmMBV6LQNLtPZMZ6om6mMdSQHMaEX
	 Nd8Kng9EzxEj/iSV5XbwZp9Ia3Vg8D0uQqvJuTelDzILl/g4fvF5D1Y1GFoqbpYknk
	 IWIPmWnWwmXv2jTuXZ90Zkl06Fmy9hn4fn3Y2mtgd1RuSGPn7dTonmjKdfaW+5RBQN
	 +03j5Yi8Rs0sQ==
To: discuss@mandoc.bsd.lv
From: "Paul A. Patience" <paul@apatience.com>
Reply-To: "Paul A. Patience" <paul@apatience.com>
Subject: Re: Proper Macro for Types
Message-ID: <87ilsk55ki.fsf@apatience.com>
X-Mailinglist: mandoc-discuss
Reply-To: discuss@mandoc.bsd.lv
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable


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 =E2=80=9C.Fa int=E2=80=9D above it makes me think it's bei=
ng 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