From owner-cvs-all Sun Jan 5 12:19:56 2003 Delivered-To: cvs-all@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 57EC537B405 for ; Sun, 5 Jan 2003 12:19:55 -0800 (PST) Received: from rootlabs.com (root.org [67.118.192.226]) by mx1.FreeBSD.org (Postfix) with SMTP id 6B4AC43EA9 for ; Sun, 5 Jan 2003 12:19:54 -0800 (PST) (envelope-from nate@rootlabs.com) Received: (qmail 7942 invoked by uid 1000); 5 Jan 2003 20:19:55 -0000 Date: Sun, 5 Jan 2003 12:19:55 -0800 (PST) From: Nate Lawson To: Bruce Evans Cc: cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org Subject: Re: cvs commit: src/share/man/man5 Makefile msdos.5 In-Reply-To: <20030106055442.X563-100000@gamplex.bde.org> Message-ID: MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII 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 On Mon, 6 Jan 2003, Bruce Evans wrote: > > > fs.5: actually does document a file format, namely the superblock > > > format > > > for 10-year old versions of ffs. This belongs in an Attic. The > > > non-rotted version is in ffs/fs.h. > > > Perhaps instead of Attic, we clean up the rot? > > I think its bits are correctly placed in ffs/fs.h (since we have open > sources). Kirk McKusick agreed with me that there is little point in > updating it and approved moving it to the Attic. I want any useful > bits in it moved to fs.h before that is done. I agree with Bruce -- interfaces are best documented in one place to prevent rot. Given the choice between man page and .h, I'd choose .h since it's less likely to rot (although we need to be intentional about documentation either way.) -Nate To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe cvs-all" in the body of the message