mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: coop@axian.com
To: linux-kernel@vger.kernel.org
Cc: coop@axian.com
Subject: Re: Documentation of module parameters.
Date: Tue, 17 Apr 2001 09:24:28 -0700	[thread overview]
Message-ID: <20010417092428.A2650@p3.coop.hom> (raw)

You can use the "modinfo" utility (Do "man modinfo".)  In particular

  modinfo -p driver.o

will give any parameters that can be set in driver.o.  If the module
author has used the MODULE_PARM_DESC() macro, more documentation
can be found.

======================================================================
 Jerry Cooperstein, PhD        <coop@axian.com>
 Senior Consultant
                                            ____       _
 Axian, Inc.   <info@axian.com>              // |_  __(_) ___  _ __
 4800 SW Griffith Dr., Ste. 202             //| |\\/ /| |/ _ \| '_ \
 Beaverton, OR  97005 USA             _____//_| | / / | | |_| | | | |
 Voice: (541)758-8020                ((   //  |_|/_/\\|_|\_/|_|_| |_|
                                      ``-''          ``-''
 http://www.axian.com/               Software Consulting and Training
======================================================================



>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 

             reply	other threads:[~2001-04-17 16:24 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2001-04-17 16:24 coop [this message]
  -- strict thread matches above, loose matches on Subject: below --
2001-04-17  3:30 Chris Kloiber
2001-04-17  5:07 ` Jonathan Lundell
2001-04-20 16:37   ` Harald Welte
2001-04-20 17:19     ` john slee
2001-04-20 17:30       ` john slee

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=20010417092428.A2650@p3.coop.hom \
    --to=coop@axian.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

all inboxes | Powered by JetHome®