Date: Sun, 10 Jan 1999 12:45:40 +0100 (CET) From: Johan Granlund <johan@granlund.nu> To: "Jordan K. Hubbard" <jkh@zippy.cdrom.com> Cc: Poul-Henning Kamp <phk@critter.freebsd.dk>, Dag-Erling Smorgrav <des@flood.ping.uio.no>, Darren Reed <darrenr@reed.wattle.id.au>, committers@FreeBSD.ORG Subject: Re: sysctl descriptions Message-ID: <Pine.BSF.4.05.9901101240110.54580-100000@phoenix.granlund.nu> In-Reply-To: <50085.915954825@zippy.cdrom.com>
next in thread | previous in thread | raw e-mail | index | archive | help
On Sat, 9 Jan 1999, Jordan K. Hubbard wrote: > > Sysctl descriptions is documentation stuff. No bit of code can read > > it for any other purpose than presentation as ASCII for the operator > > to read. > > > > There is NO reason whatsoever to load it with the kernel. Next thing > > you will what to stick documentation for all ioctl(2) calls into the > > kernel. > > > > KLD's could easily stick files into: > > > > /usr/share/doc/sysctl/desc/this/is/my/sysctl.txt > > Actually, there is a legitimate syncronization issue to be dealt with > here. If I have a sysctl implemented in one area of the code with a > doc string that describes it, I'm going to be more inclined to stick > it in the macro definition or something itself so that I have doc > string and associated sysctl code together. If I have to go remember > to edit a file somewhere as well, I'm going to forget just as > developers have been forgetting such extraneous details for years and > the problem is acute enough that entire programming paradigms > (tangle/weave) have been evolved in an effort to deal with the > problem. I'd sooner have a larger kernel if it meant that my > doc strings had a better chance of being actually *correct*. :) To solve the syncronization problem. Why not use something like Doc++ to embed dokumentation into the sourcefile? Then the dokumentation could be generated in the make process. /Johan > > - Jordan > > To Unsubscribe: send mail to majordomo@FreeBSD.org > with "unsubscribe cvs-all" in the body of the message > > 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.05.9901101240110.54580-100000>