Date: Sun, 30 Sep 2001 11:16:38 +0930 From: Greg Lehey <grog@FreeBSD.org> To: Jordan Hubbard <jkh@freebsd.org>, Dag-Erling Smorgrav <des@ofug.org> Cc: cvs-committers@freebsd.org, cvs-all@freebsd.org Subject: Documenting features (was: cvs commit: src/sys/fs/pseudofs pseudofs.c pseudofs.h pseudofs_vnops.c) Message-ID: <20010930111638.D21466@wantadilla.lemis.com> In-Reply-To: <20010929123447M.jkh@freebsd.org>; from jkh@freebsd.org on Sat, Sep 29, 2001 at 12:34:47PM -0700 References: <200109290049.f8T0nT532156@freefall.freebsd.org> <20010928200514P.jkh@freebsd.org> <xzpbsjurtyj.fsf@flood.ping.uio.no> <20010929123447M.jkh@freebsd.org> <xzpy9mxr6ls.fsf@flood.ping.uio.no> <200109290049.f8T0nT532156@freefall.freebsd.org> <20010928200514P.jkh@freebsd.org> <xzpbsjurtyj.fsf@flood.ping.uio.no> <20010929123447M.jkh@freebsd.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On Saturday, 29 September 2001 at 12:34:47 -0700, Jordan Hubbard wrote: >> Jordan Hubbard <jkh@freebsd.org> writes: >>> Erm, what's it do? I don't see a man page in there anywhere. :) >> >> You know very well what it does - it's the backend for linprocfs (and >> shortly procfs). I haven't documented it because it's been very >> volatile and WIP - thanks to the sorry state of -CURRENT I haven't >> been able to work on it for the past three months. > > Pardon me, but I do not "know very well what it does" or I wouldn't > have asked! Furthermore, since it's clearly reached the stage of > development where it can be checked in, you should also check in a man > page with it so that we don't have [even more] undocumented things > lying around the tree. This is not too much to ask. On Sunday, 30 September 2001 at 0:10:23 +0200, Dag-Erling Smorgrav wrote: > Jordan Hubbard <jkh@freebsd.org> writes: >> Pardon me, but I do not "know very well what it does" or I wouldn't >> have asked! > > We had a long discussion about pseudofs on IRC this spring, before I > committed the initial version. It's not my fault if you don't > remember any of it. Yes, it is. IRC is not a documentation medium; in fact, it performs very poorly at this function. That's by no means the only reason we have man pages. If you check in code without documentation, it's your own fault if nobody finds out what it does. The (implied) fact that jkh was party to the discussion on IRC has nothing to do with it. Like most people in the project, I wasn't there, and I have neither the foggiest idea what this does, nor the inclination to go and read the code. Greg -- See complete headers for address and phone numbers 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?20010930111638.D21466>