* [Qemu-devel] [PATCH] [RFC] Syncing documentation vs. -help vs. qemu_options table
@ 2009-03-10 21:05 Blue Swirl
0 siblings, 0 replies; only message in thread
From: Blue Swirl @ 2009-03-10 21:05 UTC (permalink / raw)
To: qemu-devel
[-- 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 --]
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2009-03-10 21:05 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-03-10 21:05 [Qemu-devel] [PATCH] [RFC] Syncing documentation vs. -help vs. qemu_options table Blue Swirl
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).