From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp-2.sys.kth.se (smtp-2.sys.kth.se [130.237.32.160]) by krisdoz.my.domain (8.14.3/8.14.3) with ESMTP id o589DfcQ008460 for ; Tue, 8 Jun 2010 05:13:41 -0400 (EDT) Received: from localhost (localhost [127.0.0.1]) by smtp-2.sys.kth.se (Postfix) with ESMTP id C0D7514E1C7 for ; Tue, 8 Jun 2010 11:13:35 +0200 (CEST) X-Virus-Scanned: by amavisd-new at kth.se Received: from smtp-2.sys.kth.se ([127.0.0.1]) by localhost (smtp-2.sys.kth.se [127.0.0.1]) (amavisd-new, port 10024) with LMTP id OTNlITloH+-c for ; Tue, 8 Jun 2010 11:13:33 +0200 (CEST) X-KTH-Auth: kristaps [85.8.61.243] X-KTH-mail-from: kristaps@bsd.lv X-KTH-rcpt-to: discuss@mdocml.bsd.lv Received: from lappy.bsd.lv (h85-8-61-243.dynamic.se.alltele.net [85.8.61.243]) by smtp-2.sys.kth.se (Postfix) with ESMTP id E789114E10A for ; Tue, 8 Jun 2010 11:13:32 +0200 (CEST) Message-ID: <4C0E09BC.9040900@bsd.lv> Date: Tue, 08 Jun 2010 11:13:32 +0200 From: Kristaps Dzonsons User-Agent: Thunderbird 2.0.0.16 (X11/20080812) X-Mailinglist: mdocml-discuss Reply-To: discuss@mdocml.bsd.lv MIME-Version: 1.0 To: "discuss@mdocml.bsd.lv" Subject: OT: Vt vs. Ft/Fn (WAS: Giving up on emulating SYNOPSIS vspace.) References: <4C0C2CC4.3040306@bsd.lv> <20100606234253.GA24356@bramka.kerhand.co.uk> <4C0CD40F.70402@bsd.lv> <20100607232645.GD8550@iris.usta.de> <4C0D83E1.5040500@bsd.lv> <20100608000646.GE8550@iris.usta.de> In-Reply-To: <20100608000646.GE8550@iris.usta.de> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit >>> 2) global variables >>> ------------------- >>> Consider /usr/src/lib/libc/rpc/svc.3: >>> >>> .Ft int >>> .Fn svc_destroy "SVCXPRT *xprt" >>> .Ft struct pollfd * >>> .Fa svc_pollfd ; >>> .Ft int >>> .Fa svc_max_pollfd ; >>> .Ft fd_set >>> .Fa svc_fdset ; >>> .Ft fd_set >>> .Fa *__svc_fdset ; >>> .Ft int >>> .Fa __svc_fdsetsize ; >>> .Ft int >>> .Fa svc_fds ; >>> .Ft int >>> .Fn svc_freeargs "SVCXPRT *xprt" "xdrproc_t inproc" "char *in" > [...] > Right, and i tried that, but being documented is not the same as > being in working order. This is what both old and new grow spit out > when you switch to .Vt/.Va: I'd meant just `Vt' instead of Vt/Va, forming int svc_destroy(SVCXPRT *xprt); struct pollfd * svc_pollfd; int svc_max_pollfd; fd_set svc_fdset; fd_set *__svc_fdset; int __svc_fdsetsize; int svc_fds; int svc_freeargs(SVCXPRT *xprt, xdrproc_t inproc, char *in); from, e.g., .Vt struct pollfd * svc_pollfd ; mdoc.samples documents `Vt' as doing funny business in SYNOPSIS, not `Va' (wtf?). From what I understand, Vt's the conventional way of putting variables in the SYNOPSIS. `F' macros are certainly not the way. jmc, wiz, any suggestions and/or observations? I like Ingo's notation of `Vt/Va'. I've never seen it before (mdocml's manuals use `Vt' standalone as suggested in mdoc.samples), but you know better. I think we can take this opportunity, in mdoc.7, to specify how variables should get documented in the SYNOPSIS. And what about the following: - CPP defines? - structs Vt's? (the `Bd' was used in one of your examples) We have `Dv' for defines, but that doesn't help me with wanting to print out `.Dv #define FOOBAR'. >> Can you commit fixes to BSD.lv as well? > > Er, frankly, no, i meant i'm going commit your reorg, i don't have > patches for the issues (1) and (2) yet. But as this concerns a very > small number of pages and all that goes awry is a few missing > blank lines, we can add these patches whenever we have them. Ah, I see... The above patches are easy enough to come by, so long as we settle on the Right Way of doing it. Thanks again, Kristaps -- To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv