From: Chris Kloiber <ckloiber@nc.rr.com>
To: linux-kernel@vger.kernel.org
Subject: Documentation of module parameters.
Date: Mon, 16 Apr 2001 23:30:17 -0400 [thread overview]
Message-ID: <3ADBB8C9.CC7FD941@nc.rr.com> (raw)
I was recently looking for a single location where all the possible
module parameters for the linux kernel was located.
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
next reply other threads:[~2001-04-17 3:32 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2001-04-17 3:30 Chris Kloiber [this message]
2001-04-17 5:07 ` Documentation of module parameters Jonathan Lundell
2001-04-20 16:37 ` Harald Welte
2001-04-20 17:19 ` john slee
2001-04-20 17:30 ` john slee
-- strict thread matches above, loose matches on Subject: below --
2001-04-17 16:24 coop
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=3ADBB8C9.CC7FD941@nc.rr.com \
--to=ckloiber@nc.rr.com \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox