aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorYihuan Pan <xun794@gmail.com>2023-12-13 22:17:07 +0800
committerThomas Huth <thuth@redhat.com>2023-12-20 10:29:23 +0100
commitfd49b2153ed2448de6798fba31430a8dccea8ed8 (patch)
tree3e28fd6a4b5d4dc3351b3125babc7a6dd98963c0 /docs
parent81c2c9dd5dc2a39b95317ca3a9baff0184f9f097 (diff)
downloadqemu-fd49b2153ed2448de6798fba31430a8dccea8ed8.zip
qemu-fd49b2153ed2448de6798fba31430a8dccea8ed8.tar.gz
qemu-fd49b2153ed2448de6798fba31430a8dccea8ed8.tar.bz2
qemu-options: Clarify handling of commas in options parameters
Provide explicit guidance on dealing with option parameters as arbitrary strings containing commas, such as in "file=my,file" and "string=a,b". The updated documentation emphasizes the need to double commas when they appear within such parameters. Resolves: https://gitlab.com/qemu-project/qemu/-/issues/1839 Signed-off-by: Yihuan Pan <xun794@gmail.com> Message-ID: <20231213141706.629833-2-xun794@gmail.com> Signed-off-by: Thomas Huth <thuth@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/system/invocation.rst5
-rw-r--r--docs/system/qemu-manpage.rst5
2 files changed, 10 insertions, 0 deletions
diff --git a/docs/system/invocation.rst b/docs/system/invocation.rst
index 4ba38fc..14b7db1 100644
--- a/docs/system/invocation.rst
+++ b/docs/system/invocation.rst
@@ -10,6 +10,11 @@ Invocation
disk_image is a raw hard disk image for IDE hard disk 0. Some targets do
not need a disk image.
+When dealing with options parameters as arbitrary strings containing
+commas, such as in "file=my,file" and "string=a,b", it's necessary to
+double the commas. For instance,"-fw_cfg name=z,string=a,,b" will be
+parsed as "-fw_cfg name=z,string=a,b".
+
.. hxtool-doc:: qemu-options.hx
Device URL Syntax
diff --git a/docs/system/qemu-manpage.rst b/docs/system/qemu-manpage.rst
index c47a412..3ade4ee 100644
--- a/docs/system/qemu-manpage.rst
+++ b/docs/system/qemu-manpage.rst
@@ -31,6 +31,11 @@ Options
disk_image is a raw hard disk image for IDE hard disk 0. Some targets do
not need a disk image.
+When dealing with options parameters as arbitrary strings containing
+commas, such as in "file=my,file" and "string=a,b", it's necessary to
+double the commas. For instance,"-fw_cfg name=z,string=a,,b" will be
+parsed as "-fw_cfg name=z,string=a,b".
+
.. hxtool-doc:: qemu-options.hx
.. include:: keys.rst.inc