From owner-freebsd-arch  Thu Oct 25 10:30:13 2001
Delivered-To: freebsd-arch@freebsd.org
Received: from flood.ping.uio.no (flood.ping.uio.no [129.240.78.31])
	by hub.freebsd.org (Postfix) with ESMTP
	id AB7FE37B405; Thu, 25 Oct 2001 10:30:07 -0700 (PDT)
Received: by flood.ping.uio.no (Postfix, from userid 2602)
	id 290D514C2E; Thu, 25 Oct 2001 19:30:06 +0200 (CEST)
X-URL: http://www.ofug.org/~des/
X-Disclaimer: The views expressed in this message do not necessarily
  coincide with those of any organisation or company with
  which I am or have been affiliated.
To: Ruslan Ermilov <ru@FreeBSD.ORG>
Cc: arch@FreeBSD.ORG
Subject: Re: "types" man page
References: <XFMail.011024095346.jhb@FreeBSD.org>
	<xzpadyhylgl.fsf@flood.ping.uio.no> <20011025190706.D41293@sunbay.com>
From: Dag-Erling Smorgrav <des@ofug.org>
Date: 25 Oct 2001 19:30:05 +0200
In-Reply-To: <20011025190706.D41293@sunbay.com>
Message-ID: <xzpsnc7vd9e.fsf@flood.ping.uio.no>
Lines: 25
User-Agent: Gnus/5.0808 (Gnus v5.8.8) Emacs/20.7
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Sender: owner-freebsd-arch@FreeBSD.ORG
Precedence: bulk
List-ID: <freebsd-arch.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20freebsd-arch>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20freebsd-arch>
X-Loop: FreeBSD.ORG

Ruslan Ermilov <ru@FreeBSD.ORG> writes:
> On Wed, Oct 24, 2001 at 07:52:26PM +0200, Dag-Erling Smorgrav wrote:
> > Ruslan, do you have a suggestion for the proper mdoc incantations for
> > a types(7) entry, based on the items I listed in my original mail?
> Just give me an example entry, and I will mark it up as needed.

pid_t
   Used to store a process ID.
   Defined in <machine/ansi.h>.
   Equivalent to a signed int on all platforms.
   Valid PIDs range from 0 through PID_MAX (defined in <sys/proc.h>)
   inclusive.  The special value NO_PID (ibid.) is used to indicate an
   invalid or nonexistent process.

The man page should also have a section that describes the
relationships between the various headers (including but probably not
limited to <machine/ansi.h>, <sys/cdefs.h>, <sys/inttypes.h>,
<sys/types.h> and <sys/param.h>) that either define these types or
include other headers which define them.  For instance, most programs
will want to include <sys/types.h> or <sys/param.h> to define pid_t,
though <sys/inttypes.h> or <machine/ansi.h> would do.

DES
-- 
Dag-Erling Smorgrav - des@ofug.org

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-arch" in the body of the message