qemu-options.hx: Improve -{read|write}config options description

Message ID 5d0f37fa917931f39f7758ae71bbb343bb309163.1342440332.git.minovotn@redhat.com
State New
Headers show

Commit Message

Pavel Hrdina July 16, 2012, 1:54 p.m.
From: Michal Novotny <minovotn@redhat.com>

This is the patch to improve description for -{read|write}config

Signed-off-by: Michal Novotny <minovotn@redhat.com>
 qemu-options.hx |    8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)


diff --git a/qemu-options.hx b/qemu-options.hx
index e15252e..97245a3 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -2713,7 +2713,9 @@  DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
 @item -readconfig @var{file}
 @findex -readconfig
-Read device configuration from @var{file}.
+Read device configuration from @var{file}. This approach is useful when you want to spawn
+QEMU process with many command line options but you don't want to exceed the command line
+character limit.
 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
     "-writeconfig <file>\n"
@@ -2721,7 +2723,9 @@  DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
 @item -writeconfig @var{file}
 @findex -writeconfig
-Write device configuration to @var{file}.
+Write device configuration to @var{file}. The @var{file} can be either filename to save
+command line and device configuration into file or dash @code{-}) character to print the
+output to stdout. This can be later used as input file for @code{-readconfig} option.
 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,