From owner-cvs-all Sun Jan 10 04:09:49 1999 Return-Path: Received: (from majordom@localhost) by hub.freebsd.org (8.8.8/8.8.8) id EAA13974 for cvs-all-outgoing; Sun, 10 Jan 1999 04:09:49 -0800 (PST) (envelope-from owner-cvs-all@FreeBSD.ORG) Received: from mail.elpost.com ([193.15.1.54]) by hub.freebsd.org (8.8.8/8.8.8) with ESMTP id EAA13968 for ; Sun, 10 Jan 1999 04:09:47 -0800 (PST) (envelope-from johan@granlund.nu) Received: from phoenix.granlund.nu (t3o29p87.telia.com [194.236.215.87]) by mail.elpost.com (2.5 Build 2626 (Berkeley 8.8.6)/8.8.4) with ESMTP id NAA00828; Sun, 10 Jan 1999 13:09:11 +0100 Received: from localhost (johan@localhost) by phoenix.granlund.nu (8.9.1/8.9.1) with ESMTP id MAA54751; Sun, 10 Jan 1999 12:45:40 +0100 (CET) (envelope-from johan@granlund.nu) Date: Sun, 10 Jan 1999 12:45:40 +0100 (CET) From: Johan Granlund To: "Jordan K. Hubbard" cc: Poul-Henning Kamp , Dag-Erling Smorgrav , Darren Reed , committers@FreeBSD.ORG Subject: Re: sysctl descriptions In-Reply-To: <50085.915954825@zippy.cdrom.com> Message-ID: MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII Sender: owner-cvs-all@FreeBSD.ORG Precedence: bulk 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