From: Blue Swirl <blauwirbel@gmail.com>
To: qemu-devel <qemu-devel@nongnu.org>
Subject: [Qemu-devel] [PATCH] [RFC] Syncing documentation vs. -help vs. qemu_options table
Date: Tue, 10 Mar 2009 23:05:22 +0200 [thread overview]
Message-ID: <f43fc5580903101405if6c256et21d0cd21db90602b@mail.gmail.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 710 bytes --]
Hi,
It would be nice if the documentation about command line switches,
-help text and qemu_options table would be kept more easily in sync.
In true Qemu tradition, this solution uses an include file that is
parsed once for getting the enums, another time for getopt tables and
third time for help message. Documentation for options is generated
from the same file with CPP.
The advantage is that all stuff is in a single location, so developers
are less likely to forget to update docs when adding new switches.
I made a reference implementation using the -parallel switch as a an example.
The new system could be introduced gradually, starting from this patch
and then converting the options.
Comments?
[-- Attachment #2: option_system.diff --]
[-- Type: plain/text, Size: 3956 bytes --]
reply other threads:[~2009-03-10 21:05 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=f43fc5580903101405if6c256et21d0cd21db90602b@mail.gmail.com \
--to=blauwirbel@gmail.com \
--cc=qemu-devel@nongnu.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;
as well as URLs for NNTP newsgroup(s).