docs/: fix some comment spelling errors
I found that there are many spelling errors in the comments of qemu, so I used the spellcheck tool to check the spelling errors and finally found some spelling errors in the docs folder. Signed-off-by: zhaolichang <zhaolichang@huawei.com> Reviewed-by: Peter Maydell <peter.maydell@linaro.org> Message-Id: <20200917075029.313-4-zhaolichang@huawei.com> Signed-off-by: Laurent Vivier <laurent@vivier.eu>
This commit is contained in:
parent
3a4452d896
commit
76ca4b58c2
|
@ -91,7 +91,7 @@ the heartbeat stops responding, the secondary node will trigger a failover
|
||||||
as soon as it determines the absence.
|
as soon as it determines the absence.
|
||||||
|
|
||||||
COLO disk Manager:
|
COLO disk Manager:
|
||||||
When primary VM writes data into image, the colo disk manger captures this data
|
When primary VM writes data into image, the colo disk manager captures this data
|
||||||
and sends it to secondary VM's which makes sure the context of secondary VM's
|
and sends it to secondary VM's which makes sure the context of secondary VM's
|
||||||
image is consistent with the context of primary VM 's image.
|
image is consistent with the context of primary VM 's image.
|
||||||
For more details, please refer to docs/block-replication.txt.
|
For more details, please refer to docs/block-replication.txt.
|
||||||
|
@ -146,12 +146,12 @@ in test procedure.
|
||||||
|
|
||||||
== Test procedure ==
|
== Test procedure ==
|
||||||
Note: Here we are running both instances on the same host for testing,
|
Note: Here we are running both instances on the same host for testing,
|
||||||
change the IP Addresses if you want to run it on two hosts. Initally
|
change the IP Addresses if you want to run it on two hosts. Initially
|
||||||
127.0.0.1 is the Primary Host and 127.0.0.2 is the Secondary Host.
|
127.0.0.1 is the Primary Host and 127.0.0.2 is the Secondary Host.
|
||||||
|
|
||||||
== Startup qemu ==
|
== Startup qemu ==
|
||||||
1. Primary:
|
1. Primary:
|
||||||
Note: Initally, $imagefolder/primary.qcow2 needs to be copied to all hosts.
|
Note: Initially, $imagefolder/primary.qcow2 needs to be copied to all hosts.
|
||||||
You don't need to change any IP's here, because 0.0.0.0 listens on any
|
You don't need to change any IP's here, because 0.0.0.0 listens on any
|
||||||
interface. The chardev's with 127.0.0.1 IP's loopback to the local qemu
|
interface. The chardev's with 127.0.0.1 IP's loopback to the local qemu
|
||||||
instance.
|
instance.
|
||||||
|
|
|
@ -62,7 +62,7 @@ Rules support the following attributes:
|
||||||
|
|
||||||
errno - the numeric errno value to return when a request matches this rule.
|
errno - the numeric errno value to return when a request matches this rule.
|
||||||
The errno values depend on the host since the numeric values are not
|
The errno values depend on the host since the numeric values are not
|
||||||
standarized in the POSIX specification.
|
standardized in the POSIX specification.
|
||||||
|
|
||||||
sector - (optional) a sector number that the request must overlap in order to
|
sector - (optional) a sector number that the request must overlap in order to
|
||||||
match this rule
|
match this rule
|
||||||
|
|
|
@ -625,7 +625,7 @@ It can be issued immediately after migration is started or any
|
||||||
time later on. Issuing it after the end of a migration is harmless.
|
time later on. Issuing it after the end of a migration is harmless.
|
||||||
|
|
||||||
Blocktime is a postcopy live migration metric, intended to show how
|
Blocktime is a postcopy live migration metric, intended to show how
|
||||||
long the vCPU was in state of interruptable sleep due to pagefault.
|
long the vCPU was in state of interruptible sleep due to pagefault.
|
||||||
That metric is calculated both for all vCPUs as overlapped value, and
|
That metric is calculated both for all vCPUs as overlapped value, and
|
||||||
separately for each vCPU. These values are calculated on destination
|
separately for each vCPU. These values are calculated on destination
|
||||||
side. To enable postcopy blocktime calculation, enter following
|
side. To enable postcopy blocktime calculation, enter following
|
||||||
|
|
|
@ -471,7 +471,7 @@ the warning.
|
||||||
A few important files for suppressing warnings are:
|
A few important files for suppressing warnings are:
|
||||||
|
|
||||||
tests/tsan/suppressions.tsan - Has TSan warnings we wish to suppress at runtime.
|
tests/tsan/suppressions.tsan - Has TSan warnings we wish to suppress at runtime.
|
||||||
The comment on each supression will typically indicate why we are
|
The comment on each suppression will typically indicate why we are
|
||||||
suppressing it. More information on the file format can be found here:
|
suppressing it. More information on the file format can be found here:
|
||||||
|
|
||||||
https://github.com/google/sanitizers/wiki/ThreadSanitizerSuppressions
|
https://github.com/google/sanitizers/wiki/ThreadSanitizerSuppressions
|
||||||
|
|
|
@ -55,7 +55,7 @@ without any sub-directory path prefix. eg io/channel-buffer.c would do
|
||||||
#include "trace.h"
|
#include "trace.h"
|
||||||
|
|
||||||
To access the 'io/trace.h' file. While it is possible to include a trace.h
|
To access the 'io/trace.h' file. While it is possible to include a trace.h
|
||||||
file from outside a source files' own sub-directory, this is discouraged in
|
file from outside a source file's own sub-directory, this is discouraged in
|
||||||
general. It is strongly preferred that all events be declared directly in
|
general. It is strongly preferred that all events be declared directly in
|
||||||
the sub-directory that uses them. The only exception is where there are some
|
the sub-directory that uses them. The only exception is where there are some
|
||||||
shared trace events defined in the top level directory trace-events file.
|
shared trace events defined in the top level directory trace-events file.
|
||||||
|
|
|
@ -484,7 +484,7 @@ Bitmaps can generally be modified at any time, but certain operations often
|
||||||
only make sense when paired directly with other commands. When a VM is paused,
|
only make sense when paired directly with other commands. When a VM is paused,
|
||||||
it's easy to ensure that no guest writes occur between individual QMP
|
it's easy to ensure that no guest writes occur between individual QMP
|
||||||
commands. When a VM is running, this is difficult to accomplish with
|
commands. When a VM is running, this is difficult to accomplish with
|
||||||
individual QMP commands that may allow guest writes to occur inbetween each
|
individual QMP commands that may allow guest writes to occur between each
|
||||||
command.
|
command.
|
||||||
|
|
||||||
For example, using only individual QMP commands, we could:
|
For example, using only individual QMP commands, we could:
|
||||||
|
|
|
@ -57,7 +57,7 @@ Depending on the use case, you may choose different scenarios:
|
||||||
- Everything the same UID
|
- Everything the same UID
|
||||||
|
|
||||||
- Convenient for developers
|
- Convenient for developers
|
||||||
- Improved reliability - crash of one part doens't take
|
- Improved reliability - crash of one part doesn't take
|
||||||
out entire VM
|
out entire VM
|
||||||
- No security benefit over traditional QEMU, unless additional
|
- No security benefit over traditional QEMU, unless additional
|
||||||
unless additional controls such as SELinux or AppArmor are
|
unless additional controls such as SELinux or AppArmor are
|
||||||
|
@ -87,7 +87,7 @@ For example, to allow only ``qemu`` user to talk to ``qemu-helper``
|
||||||
</policy>
|
</policy>
|
||||||
|
|
||||||
|
|
||||||
dbus-daemon can also perfom SELinux checks based on the security
|
dbus-daemon can also perform SELinux checks based on the security
|
||||||
context of the source and the target. For example, ``virtiofs_t``
|
context of the source and the target. For example, ``virtiofs_t``
|
||||||
could be allowed to send a message to ``svirt_t``, but ``virtiofs_t``
|
could be allowed to send a message to ``svirt_t``, but ``virtiofs_t``
|
||||||
wouldn't be allowed to send a message to ``virtiofs_t``.
|
wouldn't be allowed to send a message to ``virtiofs_t``.
|
||||||
|
|
|
@ -53,5 +53,5 @@ the operation of that feature.
|
||||||
* 2.12: NBD_CMD_BLOCK_STATUS for "base:allocation"
|
* 2.12: NBD_CMD_BLOCK_STATUS for "base:allocation"
|
||||||
* 3.0: NBD_OPT_STARTTLS with TLS Pre-Shared Keys (PSK),
|
* 3.0: NBD_OPT_STARTTLS with TLS Pre-Shared Keys (PSK),
|
||||||
NBD_CMD_BLOCK_STATUS for "qemu:dirty-bitmap:", NBD_CMD_CACHE
|
NBD_CMD_BLOCK_STATUS for "qemu:dirty-bitmap:", NBD_CMD_CACHE
|
||||||
* 4.2: NBD_FLAG_CAN_MULTI_CONN for sharable read-only exports,
|
* 4.2: NBD_FLAG_CAN_MULTI_CONN for shareable read-only exports,
|
||||||
NBD_CMD_FLAG_FAST_ZERO
|
NBD_CMD_FLAG_FAST_ZERO
|
||||||
|
|
|
@ -66,7 +66,7 @@ VhostUserGpuCursorPos
|
||||||
|
|
||||||
:scanout-id: ``u32``, the scanout where the cursor is located
|
:scanout-id: ``u32``, the scanout where the cursor is located
|
||||||
|
|
||||||
:x/y: ``u32``, the cursor postion
|
:x/y: ``u32``, the cursor position
|
||||||
|
|
||||||
VhostUserGpuCursorUpdate
|
VhostUserGpuCursorUpdate
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
|
@ -464,7 +464,7 @@ the ``VHOST_USER_SET_MEM_TABLE`` request. For invalidation events, the
|
||||||
(3), the I/O virtual address and the size. On success, the slave is
|
(3), the I/O virtual address and the size. On success, the slave is
|
||||||
expected to reply with a zero payload, non-zero otherwise.
|
expected to reply with a zero payload, non-zero otherwise.
|
||||||
|
|
||||||
The slave relies on the slave communcation channel (see :ref:`Slave
|
The slave relies on the slave communication channel (see :ref:`Slave
|
||||||
communication <slave_communication>` section below) to send IOTLB miss
|
communication <slave_communication>` section below) to send IOTLB miss
|
||||||
and access failure events, by sending ``VHOST_USER_SLAVE_IOTLB_MSG``
|
and access failure events, by sending ``VHOST_USER_SLAVE_IOTLB_MSG``
|
||||||
requests to the master with a ``struct vhost_iotlb_msg`` as
|
requests to the master with a ``struct vhost_iotlb_msg`` as
|
||||||
|
@ -1450,7 +1450,7 @@ vhost-user backends can provide various devices & services and may
|
||||||
need to be configured manually depending on the use case. However, it
|
need to be configured manually depending on the use case. However, it
|
||||||
is a good idea to follow the conventions listed here when
|
is a good idea to follow the conventions listed here when
|
||||||
possible. Users, QEMU or libvirt, can then rely on some common
|
possible. Users, QEMU or libvirt, can then rely on some common
|
||||||
behaviour to avoid heterogenous configuration and management of the
|
behaviour to avoid heterogeneous configuration and management of the
|
||||||
backend programs and facilitate interoperability.
|
backend programs and facilitate interoperability.
|
||||||
|
|
||||||
Each backend installed on a host system should come with at least one
|
Each backend installed on a host system should come with at least one
|
||||||
|
|
|
@ -261,7 +261,7 @@ qemu_rdma_exchange_send(header, data, optional response header & data):
|
||||||
of the connection (described below).
|
of the connection (described below).
|
||||||
|
|
||||||
All of the remaining command types (not including 'ready')
|
All of the remaining command types (not including 'ready')
|
||||||
described above all use the aformentioned two functions to do the hard work:
|
described above all use the aforementioned two functions to do the hard work:
|
||||||
|
|
||||||
1. After connection setup, RAMBlock information is exchanged using
|
1. After connection setup, RAMBlock information is exchanged using
|
||||||
this protocol before the actual migration begins. This information includes
|
this protocol before the actual migration begins. This information includes
|
||||||
|
|
|
@ -371,7 +371,7 @@ ibm,dynamic-memory
|
||||||
|
|
||||||
This property describes the dynamically reconfigurable memory. It is a
|
This property describes the dynamically reconfigurable memory. It is a
|
||||||
property encoded array that has an integer N, the number of LMBs followed
|
property encoded array that has an integer N, the number of LMBs followed
|
||||||
by N LMB list entires.
|
by N LMB list entries.
|
||||||
|
|
||||||
Each LMB list entry consists of the following elements:
|
Each LMB list entry consists of the following elements:
|
||||||
|
|
||||||
|
@ -390,7 +390,7 @@ Each LMB list entry consists of the following elements:
|
||||||
ibm,dynamic-memory-v2
|
ibm,dynamic-memory-v2
|
||||||
|
|
||||||
This property describes the dynamically reconfigurable memory. This is
|
This property describes the dynamically reconfigurable memory. This is
|
||||||
an alternate and newer way to describe dyanamically reconfigurable memory.
|
an alternate and newer way to describe dynamically reconfigurable memory.
|
||||||
It is a property encoded array that has an integer N (the number of
|
It is a property encoded array that has an integer N (the number of
|
||||||
LMB set entries) followed by N LMB set entries. There is an LMB set entry
|
LMB set entries) followed by N LMB set entries. There is an LMB set entry
|
||||||
for each sequential group of LMBs that share common attributes.
|
for each sequential group of LMBs that share common attributes.
|
||||||
|
|
|
@ -46,7 +46,7 @@ default mode. ``dual`` means that both modes XICS **and** XIVE are
|
||||||
supported and if the guest OS supports XIVE, this mode will be
|
supported and if the guest OS supports XIVE, this mode will be
|
||||||
selected.
|
selected.
|
||||||
|
|
||||||
The choosen interrupt mode is activated after a reconfiguration done
|
The chosen interrupt mode is activated after a reconfiguration done
|
||||||
in a machine reset.
|
in a machine reset.
|
||||||
|
|
||||||
KVM negotiation
|
KVM negotiation
|
||||||
|
@ -158,7 +158,7 @@ XIVE Device tree properties
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
The properties for the PAPR interrupt controller node when the *XIVE
|
The properties for the PAPR interrupt controller node when the *XIVE
|
||||||
native exploitation mode* is selected shoud contain:
|
native exploitation mode* is selected should contain:
|
||||||
|
|
||||||
- ``device_type``
|
- ``device_type``
|
||||||
|
|
||||||
|
|
|
@ -72,7 +72,7 @@ Boot options
|
||||||
------------
|
------------
|
||||||
|
|
||||||
The Aspeed machines can be started using the -kernel option to load a
|
The Aspeed machines can be started using the -kernel option to load a
|
||||||
Linux kernel or from a firmare image which can be downloaded from the
|
Linux kernel or from a firmware image which can be downloaded from the
|
||||||
OpenPOWER jenkins :
|
OpenPOWER jenkins :
|
||||||
|
|
||||||
https://openpower.xyz/
|
https://openpower.xyz/
|
||||||
|
|
|
@ -79,7 +79,7 @@ Creating sound card devices and vnc without ``audiodev=`` property (since 4.2)
|
||||||
|
|
||||||
When not using the deprecated legacy audio config, each sound card
|
When not using the deprecated legacy audio config, each sound card
|
||||||
should specify an ``audiodev=`` property. Additionally, when using
|
should specify an ``audiodev=`` property. Additionally, when using
|
||||||
vnc, you should specify an ``audiodev=`` propery if you plan to
|
vnc, you should specify an ``audiodev=`` property if you plan to
|
||||||
transmit audio through the VNC protocol.
|
transmit audio through the VNC protocol.
|
||||||
|
|
||||||
Creating sound card devices using ``-soundhw`` (since 5.1)
|
Creating sound card devices using ``-soundhw`` (since 5.1)
|
||||||
|
@ -111,7 +111,7 @@ Splitting RAM by default between NUMA nodes has the same issues as ``mem``
|
||||||
parameter described above with the difference that the role of the user plays
|
parameter described above with the difference that the role of the user plays
|
||||||
QEMU using implicit generic or board specific splitting rule.
|
QEMU using implicit generic or board specific splitting rule.
|
||||||
Use ``memdev`` with *memory-backend-ram* backend or ``mem`` (if
|
Use ``memdev`` with *memory-backend-ram* backend or ``mem`` (if
|
||||||
it's supported by used machine type) to define mapping explictly instead.
|
it's supported by used machine type) to define mapping explicitly instead.
|
||||||
|
|
||||||
``-mem-path`` fallback to RAM (since 4.1)
|
``-mem-path`` fallback to RAM (since 4.1)
|
||||||
'''''''''''''''''''''''''''''''''''''''''
|
'''''''''''''''''''''''''''''''''''''''''
|
||||||
|
@ -541,10 +541,10 @@ The ``[hub_id name]`` parameter tuple of the 'hostfwd_add' and
|
||||||
Guest Emulator ISAs
|
Guest Emulator ISAs
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
RISC-V ISA privledge specification version 1.09.1 (removed in 5.1)
|
RISC-V ISA privilege specification version 1.09.1 (removed in 5.1)
|
||||||
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
|
||||||
|
|
||||||
The RISC-V ISA privledge specification version 1.09.1 has been removed.
|
The RISC-V ISA privilege specification version 1.09.1 has been removed.
|
||||||
QEMU supports both the newer version 1.10.0 and the ratified version 1.11.0, these
|
QEMU supports both the newer version 1.10.0 and the ratified version 1.11.0, these
|
||||||
should be used instead of the 1.09.1 version.
|
should be used instead of the 1.09.1 version.
|
||||||
|
|
||||||
|
|
|
@ -10,7 +10,7 @@ xmega6 and xmega7.
|
||||||
|
|
||||||
As for now it supports few Arduino boards for educational and testing purposes.
|
As for now it supports few Arduino boards for educational and testing purposes.
|
||||||
These boards use a ATmega controller, which model is limited to USART & 16-bit
|
These boards use a ATmega controller, which model is limited to USART & 16-bit
|
||||||
timer devices, enought to run FreeRTOS based applications (like
|
timer devices, enough to run FreeRTOS based applications (like
|
||||||
https://github.com/seharris/qemu-avr-tests/blob/master/free-rtos/Demo/AVR_ATMega2560_GCC/demo.elf
|
https://github.com/seharris/qemu-avr-tests/blob/master/free-rtos/Demo/AVR_ATMega2560_GCC/demo.elf
|
||||||
).
|
).
|
||||||
|
|
||||||
|
@ -30,7 +30,7 @@ AVR cpu
|
||||||
|
|
||||||
telnet localhost 5678
|
telnet localhost 5678
|
||||||
|
|
||||||
- Debugging wit GDB debugger::
|
- Debugging with GDB debugger::
|
||||||
|
|
||||||
qemu-system-avr -machine mega2560 -bios demo.elf -s -S
|
qemu-system-avr -machine mega2560 -bios demo.elf -s -S
|
||||||
|
|
||||||
|
|
|
@ -76,7 +76,7 @@ Options
|
||||||
I/O timeout in seconds. The default depends on cache= option.
|
I/O timeout in seconds. The default depends on cache= option.
|
||||||
|
|
||||||
* writeback|no_writeback -
|
* writeback|no_writeback -
|
||||||
Enable/disable writeback cache. The cache alows the FUSE client to buffer
|
Enable/disable writeback cache. The cache allows the FUSE client to buffer
|
||||||
and merge write requests. The default is ``no_writeback``.
|
and merge write requests. The default is ``no_writeback``.
|
||||||
|
|
||||||
* xattr|no_xattr -
|
* xattr|no_xattr -
|
||||||
|
|
Loading…
Reference in New Issue