mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Magnus Damm <damm@opensource.se>
To: linux-kernel@vger.kernel.org
Cc: Magnus Damm <damm@opensource.se>
Subject: [PATCH 0/5] autoparam
Date: Mon, 21 Mar 2005 00:06:06 +0100 (CET)	[thread overview]
Message-ID: <20050320223814.25305.52695.65404@clementine.local> (raw)

Here are a set of patches that makes it possible to autogenerate kernel command
line documentation from the source code. The approach is rather straightforward
- the parameter name, the type and the description are stored in a section 
called __param_strings. After vmlinux is built this section is extracted using
objcopy and a script is used to generate a primitive - but up to date - 
document.

Right now the section is left in the kernel binary. The document is currently
not generated from the Makefile, so the curious user should perform:

$ objcopy -j __param_strings vmlinux -O binary foo
$ chmod a+x scripts/section2text.rb
$ cat foo | ./scripts/section2text.rb

And yeah, you need to install ruby to run the script.

The ruby script section2text.rb does some checks to see if MODULE_PARM_DESC()
is used without module_param(). You will find interesting typos.

Future work that extends this idea could include replacing __setup(name) with 
__setup(name, descr). And storing the documentation somewhere to make it easy
for the end user to look up the generated parameter list from the boot loader.

/ magnus


             reply	other threads:[~2005-03-20 23:06 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-03-20 23:06 Magnus Damm [this message]
2005-03-20 23:06 ` [PATCH 1/5] autoparam: includes Magnus Damm
2005-03-20 23:06 ` [PATCH 2/5] autoparam: script Magnus Damm
2005-03-20 23:06 ` [PATCH 3/5] autoparam: af_unix workaround Magnus Damm
2005-03-20 23:06 ` [PATCH 4/5] autoparam: ide workarounds Magnus Damm
2005-03-20 23:06 ` [PATCH 5/5] autoparam: various fixes Magnus Damm
2005-04-09 18:21 ` [PATCH 0/5] autoparam Domen Puncer
2005-04-11 10:15   ` Magnus Damm

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=20050320223814.25305.52695.65404@clementine.local \
    --to=damm@opensource.se \
    --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®