Date: Wed, 19 Mar 1997 13:13:59 -0800 (PST) From: Mike Pritchard <mpp> To: bde@freefall.freebsd.org (Bruce Evans) Cc: CVS-committers@freefall.freebsd.org, cvs-all@freefall.freebsd.org, cvs-share@freefall.freebsd.org Subject: Re: cvs commit: src/share/man/man3 fpgetround.3 Message-ID: <199703192114.NAA22739@freefall.freebsd.org> In-Reply-To: <199703192042.MAA20789@freefall.freebsd.org> from "Bruce Evans" at Mar 19, 97 12:42:22 pm
next in thread | previous in thread | raw e-mail | index | archive | help
Bruce Evans wrote: > > bde 97/03/19 12:42:19 > > Modified: share/man/man3 fpgetround.3 > Log: > Fixed misuse of .Ft for enum members. (.Fa seems to be the best > available macro for enum, struct and union members. .Ft seems to > be the best available macro for enum, struct and union tags and > types). I was trying to figure out the best way to do this, and I'm leaning towards removing this type of thing from the SYNOPSIS section. I think they are better placed in the main manual page text, and defined within literal text blocks. Someone who is just checking the top of the man page to see what arguments the function takes really doesn't need to know how the fd_rnd typedef is defined (for example). If they need more information, then the are probably going to read the entire man page anyways. I know that ther are a few other man pages that abuse the SYNOPSIS section and put a page or two of #defines and what not in there before there is even any discussion of the function. -- Mike Pritchard mpp@FreeBSD.org "Go that way. Really fast. If something gets in your way, turn"
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?199703192114.NAA22739>