Date: Sun, 5 Jan 2003 12:19:55 -0800 (PST) From: Nate Lawson <nate@root.org> To: Bruce Evans <bde@zeta.org.au> Cc: cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org Subject: Re: cvs commit: src/share/man/man5 Makefile msdos.5 Message-ID: <Pine.BSF.4.21.0301051217510.7893-100000@root.org> In-Reply-To: <20030106055442.X563-100000@gamplex.bde.org>
next in thread | previous in thread | raw e-mail | index | archive | help
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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?Pine.BSF.4.21.0301051217510.7893-100000>