Message ID | 20230829132948.51053-1-thuth@redhat.com |
---|---|
State | New |
Headers | show |
Series | qemu-options.hx: Rephrase the descriptions of the -hd* and -cdrom options | expand |
Thomas Huth <thuth@redhat.com> writes: > The current description says that these options will create a device > on the IDE bus, which is only true on x86. So rephrase these sentences > a little bit to speak of "default bus" instead. > > Signed-off-by: Thomas Huth <thuth@redhat.com> > --- > qemu-options.hx | 20 ++++++++++++-------- > 1 file changed, 12 insertions(+), 8 deletions(-) > > diff --git a/qemu-options.hx b/qemu-options.hx > index 29b98c3d4c..a7ce5f0f7a 100644 > --- a/qemu-options.hx > +++ b/qemu-options.hx > @@ -1209,10 +1209,10 @@ SRST > ERST > > DEF("hda", HAS_ARG, QEMU_OPTION_hda, > - "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) > + "-hda/-hdb file use 'file' as hard disk 0/1 image\n", QEMU_ARCH_ALL) > DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) > DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, > - "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) > + "-hdc/-hdd file use 'file' as hard disk 2/3 image\n", QEMU_ARCH_ALL) > DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) > SRST > ``-hda file`` > @@ -1222,18 +1222,22 @@ SRST > ``-hdc file`` > \ > ``-hdd file`` > - Use file as hard disk 0, 1, 2 or 3 image (see the :ref:`disk images` > - chapter in the System Emulation Users Guide). > + Use file as hard disk 0, 1, 2 or 3 image on the default bus of the > + emulated machine (this is for example the IDE bus on most x86 machines, > + but it can also be SCSI, virtio or something else on other target > + architectures). See al the :ref:`disk images` chapter in the > System See also? > + Emulation Users Guide. > ERST > > DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, > - "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", > + "-cdrom file use 'file' as CD-ROM image\n", > QEMU_ARCH_ALL) > SRST > ``-cdrom file`` > - Use file as CD-ROM image (you cannot use ``-hdc`` and ``-cdrom`` at > - the same time). You can use the host CD-ROM by using ``/dev/cdrom`` > - as filename. > + Use file as CD-ROM image on the default bus of the emulated machine > + (which is IDE1 master on x86, so you cannot use ``-hdc`` and ``-cdrom`` > + at the same time there). On systems that support it, you can use the > + host CD-ROM by using ``/dev/cdrom`` as filename. > ERST > > DEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev, Otherwise: Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
On 29/08/2023 18.39, Alex Bennée wrote: > > Thomas Huth <thuth@redhat.com> writes: > >> The current description says that these options will create a device >> on the IDE bus, which is only true on x86. So rephrase these sentences >> a little bit to speak of "default bus" instead. >> >> Signed-off-by: Thomas Huth <thuth@redhat.com> >> --- >> qemu-options.hx | 20 ++++++++++++-------- >> 1 file changed, 12 insertions(+), 8 deletions(-) >> >> diff --git a/qemu-options.hx b/qemu-options.hx >> index 29b98c3d4c..a7ce5f0f7a 100644 >> --- a/qemu-options.hx >> +++ b/qemu-options.hx >> @@ -1209,10 +1209,10 @@ SRST >> ERST >> >> DEF("hda", HAS_ARG, QEMU_OPTION_hda, >> - "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) >> + "-hda/-hdb file use 'file' as hard disk 0/1 image\n", QEMU_ARCH_ALL) >> DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) >> DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, >> - "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) >> + "-hdc/-hdd file use 'file' as hard disk 2/3 image\n", QEMU_ARCH_ALL) >> DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) >> SRST >> ``-hda file`` >> @@ -1222,18 +1222,22 @@ SRST >> ``-hdc file`` >> \ >> ``-hdd file`` >> - Use file as hard disk 0, 1, 2 or 3 image (see the :ref:`disk images` >> - chapter in the System Emulation Users Guide). >> + Use file as hard disk 0, 1, 2 or 3 image on the default bus of the >> + emulated machine (this is for example the IDE bus on most x86 machines, >> + but it can also be SCSI, virtio or something else on other target >> + architectures). See al the :ref:`disk images` chapter in the >> System > > See also? Drat, yes, that was a typo. >> + Emulation Users Guide. >> ERST >> >> DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, >> - "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", >> + "-cdrom file use 'file' as CD-ROM image\n", >> QEMU_ARCH_ALL) >> SRST >> ``-cdrom file`` >> - Use file as CD-ROM image (you cannot use ``-hdc`` and ``-cdrom`` at >> - the same time). You can use the host CD-ROM by using ``/dev/cdrom`` >> - as filename. >> + Use file as CD-ROM image on the default bus of the emulated machine >> + (which is IDE1 master on x86, so you cannot use ``-hdc`` and ``-cdrom`` >> + at the same time there). On systems that support it, you can use the >> + host CD-ROM by using ``/dev/cdrom`` as filename. >> ERST >> >> DEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev, > > Otherwise: > > Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Thanks! Thomas
29.08.2023 16:29, Thomas Huth wrote: > The current description says that these options will create a device > on the IDE bus, which is only true on x86. So rephrase these sentences > a little bit to speak of "default bus" instead. applied to my trivial tree, with the "See also" fix. /mjt
diff --git a/qemu-options.hx b/qemu-options.hx index 29b98c3d4c..a7ce5f0f7a 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -1209,10 +1209,10 @@ SRST ERST DEF("hda", HAS_ARG, QEMU_OPTION_hda, - "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) + "-hda/-hdb file use 'file' as hard disk 0/1 image\n", QEMU_ARCH_ALL) DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, - "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) + "-hdc/-hdd file use 'file' as hard disk 2/3 image\n", QEMU_ARCH_ALL) DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) SRST ``-hda file`` @@ -1222,18 +1222,22 @@ SRST ``-hdc file`` \ ``-hdd file`` - Use file as hard disk 0, 1, 2 or 3 image (see the :ref:`disk images` - chapter in the System Emulation Users Guide). + Use file as hard disk 0, 1, 2 or 3 image on the default bus of the + emulated machine (this is for example the IDE bus on most x86 machines, + but it can also be SCSI, virtio or something else on other target + architectures). See al the :ref:`disk images` chapter in the System + Emulation Users Guide. ERST DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, - "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", + "-cdrom file use 'file' as CD-ROM image\n", QEMU_ARCH_ALL) SRST ``-cdrom file`` - Use file as CD-ROM image (you cannot use ``-hdc`` and ``-cdrom`` at - the same time). You can use the host CD-ROM by using ``/dev/cdrom`` - as filename. + Use file as CD-ROM image on the default bus of the emulated machine + (which is IDE1 master on x86, so you cannot use ``-hdc`` and ``-cdrom`` + at the same time there). On systems that support it, you can use the + host CD-ROM by using ``/dev/cdrom`` as filename. ERST DEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev,
The current description says that these options will create a device on the IDE bus, which is only true on x86. So rephrase these sentences a little bit to speak of "default bus" instead. Signed-off-by: Thomas Huth <thuth@redhat.com> --- qemu-options.hx | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-)