From owner-cvs-share  Wed Mar 19 13:24:40 1997
Return-Path: <owner-cvs-share>
Received: (from root@localhost)
          by freefall.freebsd.org (8.8.5/8.8.5) id NAA23429
          for cvs-share-outgoing; Wed, 19 Mar 1997 13:24:40 -0800 (PST)
Received: (from mpp@localhost)
          by freefall.freebsd.org (8.8.5/8.8.5) id NAA23219;
          Wed, 19 Mar 1997 13:21:24 -0800 (PST)
From: Mike Pritchard <mpp>
Message-Id: <199703192121.NAA23219@freefall.freebsd.org>
Subject: Re: cvs commit:  src/share/man/man3 fpgetround.3
To: mpp@freefall.freebsd.org (Mike Pritchard)
Date: Wed, 19 Mar 1997 13:21:23 -0800 (PST)
Cc: bde@freefall.freebsd.org, CVS-committers@freefall.freebsd.org,
        cvs-all@freefall.freebsd.org, cvs-share@freefall.freebsd.org
In-Reply-To: <199703192114.NAA22739@freefall.freebsd.org> from "Mike Pritchard" at Mar 19, 97 01:13:59 pm
X-Mailer: ELM [version 2.4 PL24]
Content-Type: text
Sender: owner-cvs-share@FreeBSD.ORG
X-Loop: FreeBSD.org
Precedence: bulk

Mike Pritchard wrote:
> 
> 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.

On the other hand (you know, I just hate it when I immediately followup
one of my own replies :-), something like "man 2 flock" is a good
example of how this type of information can be useful when included
in the SYNOPSIS section.
-- 
Mike Pritchard
mpp@FreeBSD.org
"Go that way.  Really fast.  If something gets in your way, turn"