ShuriZma
/
xemu
mirror of https://github.com/xemu-project/xemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Yihuan Pan 2023-12-13 22:17:07 +08:00 committed by Thomas Huth
parent 81c2c9dd5d
commit fd49b2153e
3 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/system/invocation.rst
View File

@ -10,6 +10,11 @@ Invocation
disk_image is a raw hard disk image for IDE hard disk 0. Some targets do disk_image is a raw hard disk image for IDE hard disk 0. Some targets do
not need a disk image. 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 .. hxtool-doc:: qemu-options.hx
Device URL Syntax Device URL Syntax

5
docs/system/qemu-manpage.rst
View File

@ -31,6 +31,11 @@ Options
disk_image is a raw hard disk image for IDE hard disk 0. Some targets do disk_image is a raw hard disk image for IDE hard disk 0. Some targets do
not need a disk image. 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 .. hxtool-doc:: qemu-options.hx
.. include:: keys.rst.inc .. include:: keys.rst.inc

4
qemu-options.hx
View File

@ -4086,9 +4086,13 @@ DEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg,
SRST SRST
``-fw_cfg [name=]name,file=file`` ``-fw_cfg [name=]name,file=file``
Add named fw\_cfg entry with contents from file file. Add named fw\_cfg entry with contents from file file.
If the filename contains comma, you must double it (for instance,
"file=my,,file" to use file "my,file").
``-fw_cfg [name=]name,string=str`` ``-fw_cfg [name=]name,string=str``
Add named fw\_cfg entry with contents from string str. Add named fw\_cfg entry with contents from string str.
If the string contains comma, you must double it (for instance,
"string=my,,string" to use file "my,string").
The terminating NUL character of the contents of str will not be The terminating NUL character of the contents of str will not be
included as part of the fw\_cfg item data. To insert contents with included as part of the fw\_cfg item data. To insert contents with