From owner-cvs-all Sun Jul 29 6:48: 9 2001 Delivered-To: cvs-all@freebsd.org Received: from bazooka.unixfreak.org (bazooka.unixfreak.org [63.198.170.138]) by hub.freebsd.org (Postfix) with ESMTP id 87FAD37B401; Sun, 29 Jul 2001 06:48:04 -0700 (PDT) (envelope-from dima@unixfreak.org) Received: by bazooka.unixfreak.org (Postfix, from userid 1000) id 3AFFC3E28; Sun, 29 Jul 2001 06:48:04 -0700 (PDT) Received: from bazooka.unixfreak.org (localhost [127.0.0.1]) by bazooka.unixfreak.org (Postfix) with ESMTP id 2AB7C3C12B; Sun, 29 Jul 2001 06:48:04 -0700 (PDT) To: Sheldon Hearn Cc: cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org Subject: Re: cvs commit: src/lib/libmp mp.3 In-Reply-To: <35558.996413506@axl.seasidesoftware.co.za>; from sheldonh@starjuice.net on "Sun, 29 Jul 2001 15:31:46 +0200" Date: Sun, 29 Jul 2001 06:47:59 -0700 From: Dima Dorfman Message-Id: <20010729134804.3AFFC3E28@bazooka.unixfreak.org> Sender: owner-cvs-all@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.ORG Sheldon Hearn writes: > > > On Sun, 29 Jul 2001 06:19:17 MST, Dima Dorfman wrote: > > > Added files: > > lib/libmp mp.3 > > Log: > > Add a manual page for the libmp interface. It isn't real great, [...] > > That's because this isn't the way library functions are supposed to be > documented in FreeBSD. I meant some of the descriptions, not the format. > Library functions should be documented in pages named after the > functions. Where a few functions are closely related (by virtue of more > than just being offered by the same library), they can be grouped into a > single page. They are related in ways other than being in the same library; they all comprise one, standalone interface. There is ample precedent for this: libalias, libdisk, libradius, libstand, libtacplus, and libusb (submitted by: `ls /usr/share/man/man3/lib*`). The reason these are all grouped into single man pages is because these are all pretty special-purpose libraries, and somebody that uses one of the routines will most likely need the others. It isn't like libc where it's reasonable to use half of it and not know that the other half exists. To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe cvs-all" in the body of the message