From owner-freebsd-current Mon Jun 29 02:52:37 1998 Return-Path: Received: (from majordom@localhost) by hub.freebsd.org (8.8.8/8.8.8) id CAA12956 for freebsd-current-outgoing; Mon, 29 Jun 1998 02:52:37 -0700 (PDT) (envelope-from owner-freebsd-current@FreeBSD.ORG) Received: from nlsystems.com (nlsys.demon.co.uk [158.152.125.33]) by hub.freebsd.org (8.8.8/8.8.8) with ESMTP id CAA12933 for ; Mon, 29 Jun 1998 02:52:27 -0700 (PDT) (envelope-from dfr@nlsystems.com) Received: from herring.nlsystems.com (herring.nlsystems.com [10.0.0.2]) by nlsystems.com (8.8.8/8.8.5) with SMTP id KAA18891; Mon, 29 Jun 1998 10:57:30 +0100 (BST) Date: Mon, 29 Jun 1998 10:57:29 +0100 (BST) From: Doug Rabson To: Dag-Erling Coidan Smrgrav cc: Thomas Dean , current@FreeBSD.ORG Subject: Re: Draft manpages available for review In-Reply-To: Message-ID: MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII Sender: owner-freebsd-current@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.ORG On 29 Jun 1998, Dag-Erling Coidan Smrgrav wrote: > Doug Rabson writes: > > > Some man pages do not have 'Return Values' sections. > > > [...] > > I didn't bother with a 'Return Values' section for functions which were > > void or where the return value was described in the 'Description' section. > > Bzzzt, if you basically know what the function does but are unsure > about the return values, having a separate RETURN VALUES section is > very useful since it makes finding this information much quicker. Most of these functions are just accessors. They don't actually *do* anything, just return stuff. Maybe I should just rename the 'DESCRIPTION' section to 'RETURN VALUES'. -- Doug Rabson Mail: dfr@nlsystems.com Nonlinear Systems Ltd. Phone: +44 181 951 1891 Fax: +44 181 381 1039 To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-current" in the body of the message