[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH] [RFC] Syncing documentation vs. -help vs. qemu_opti
[Qemu-devel] [PATCH] [RFC] Syncing documentation vs. -help vs. qemu_options table
Tue, 10 Mar 2009 23:05:22 +0200
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.
|[Prev in Thread]
||[Next in Thread]|
- [Qemu-devel] [PATCH] [RFC] Syncing documentation vs. -help vs. qemu_options table,
Blue Swirl <=