Mime-Version: 1.0
Message-Id: <p05100b07b7017fc83c2e@[207.213.214.34]>
In-Reply-To: <3ADBB8C9.CC7FD941@nc.rr.com>
In-Reply-To: <3ADBB8C9.CC7FD941@nc.rr.com>
Date: Mon, 16 Apr 2001 22:07:56 -0700
To: linux-kernel@vger.kernel.org
From: Jonathan Lundell <jlundell@pobox.com>
Subject: Re: Documentation of module parameters.
Content-Type: text/plain; charset="us-ascii"
Sender: linux-kernel-owner@vger.kernel.org

At 11:30 PM -0400 2001-04-16, Chris Kloiber wrote:
>I was recently looking for a single location where all the possible
>module parameters for the linux kernel was located.

Hear him. A DocBook document would be a dandy place for this to get pulled together, too.

>I figured I would look at the source first, hoping that each module
>maintaier would clearly document at the beginning of each .c file all of
>the parameters his or her module can accept. Sadly, that's not always
>the case. Some modules are well documented, others are a complete
>mystery. If I was a programmer myself, I might be able to determine from
>the code itself what parameters are possible, but that's not one of my
>talents. Could any and all of you please take the time to document your
>code, and keep the comments up to date when it changes? I think that in
>the source code itself is the best place for such documentation, as you
>have the chance to fix the docs with every patch, and the source is
>always included in each distribution. Then from the source can any
>exterior documentation be gleaned. Those of us who don't speak C would
>really appreciate it.
>
>Thanks In Advance.
>
>Chris Kloiber


-- 
/Jonathan Lundell.
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/