[libvirt PATCH 1/5] docs: fix misc spelling errors reported by codespell

Signed-off-by: Daniel P. Berrangé <berrange(a)redhat.com&gt; --- NEWS.rst | 8 ++++---- docs/auth.html.in | 2 +- docs/daemons.rst | 4 ++-- docs/drvesx.html.in | 6 +++--- docs/drvxen.html.in | 2 +- docs/format.html.in | 2 +- docs/formatdomain.rst | 6 +++--- docs/formatdomaincaps.html.in | 2 +- docs/formatnetwork.html.in | 4 ++-- docs/formatnode.html.in | 2 +- docs/formatstorage.html.in | 2 +- docs/formatstoragecaps.html.in | 2 +- docs/hooks.html.in | 4 ++-- docs/kbase/backing_chains.rst | 2 +- docs/kbase/debuglogs.rst | 6 +++--- docs/kbase/kvm-realtime.rst | 2 +- docs/kbase/migrationinternals.rst | 2 +- docs/kbase/rpm-deployment.rst | 2 +- docs/logos/README | 2 +- docs/manpages/virsh.rst | 2 +- docs/manpages/virt-login-shell.rst | 8 ++++---- docs/schemas/basictypes.rng | 2 +- docs/schemas/domaincommon.rng | 2 +- docs/securityprocess.html.in | 2 +- docs/strategy.html.in | 2 +- docs/uri.html.in | 2 +- 26 files changed, 41 insertions(+), 41 deletions(-) diff --git a/NEWS.rst b/NEWS.rst index de46cac8c5..18b8e615a6 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -457,7 +457,7 @@ v6.3.0 (2020-05-05) libvirt can now set the "hotplug" option for pcie-root-ports and pcie-switch-downstream-ports, which can be used to disable hotplug/unplug of devices from these ports (default behavior is for these controllers to - accept all hotplug/unplug attempts, but this is often undesireable). + accept all hotplug/unplug attempts, but this is often undesirable). * vbox: added support for version 6.0 and 6.1 APIs @@ -941,7 +941,7 @@ v5.10.0 (2019-12-02) * Forcibly create nodes in domain's namespace - The QEMU driver starts a domain in a namepsace with private ``/dev`` and + The QEMU driver starts a domain in a namespace with private ``/dev`` and creates only those nodes there which the domain is configured to have. However, it may have happened that if a node changed its minor number this change wasn't propagated to the namespace. @@ -1244,7 +1244,7 @@ v5.6.0 (2019-08-05) * network: Allow passing arbitrary options to dnsmasq - This works similarly to the existing support for passing arbitary options + This works similarly to the existing support for passing arbitrary options to QEMU, and just like that feature it comes with no support guarantees. * **Removed features** @@ -2258,7 +2258,7 @@ v4.4.0 (2018-06-04) * **Improvements** - * qemu: Add suport for OpenGL rendering with SDL + * qemu: Add support for OpenGL rendering with SDL Domains using SDL as a graphics backend will now be able to use OpenGL accelerated rendering. diff --git a/docs/auth.html.in b/docs/auth.html.in index 9964313776..9b940a8598 100644 --- a/docs/auth.html.in +++ b/docs/auth.html.in @@ -277,7 +277,7 @@ to turn on SASL auth in these listeners. <p> Since the libvirt SASL config file defaults to using GSSAPI (Kerberos), a config change is required to enable plain password auth. This is done by -editting <code>/etc/sasl2/libvirt.conf</code> to set the <code>mech_list</code> +editing <code>/etc/sasl2/libvirt.conf</code> to set the <code>mech_list</code> parameter to <code>scram-sha-1</code>. </p> <p> diff --git a/docs/daemons.rst b/docs/daemons.rst index e0b95105e4..2cd6b47c2a 100644 --- a/docs/daemons.rst +++ b/docs/daemons.rst @@ -512,7 +512,7 @@ other end of which are owned by the ``virtlogd`` daemon. It will then write data on those pipes to log files, while enforcing a maximum file size and performing log rollover at the size limit. -Since the daemon holds open anoymous pipe file descriptors, it must never be +Since the daemon holds open anonymous pipe file descriptors, it must never be stopped while any QEMU virtual machines are running. To enable software updates to be applied, the daemon is capable of re-executing itself while keeping all file descriptors open. This can be triggered by sending the daemon ``SIGUSR1`` @@ -605,7 +605,7 @@ images and devices serving as backing storage for virtual disks. The locks will be held for as long as there is a QEMU process running with the disk open. -To ensure continuity of locking, the daemon holds open anoymous file +To ensure continuity of locking, the daemon holds open anonymous file descriptors, it must never be stopped while any QEMU virtual machines are running. To enable software updates to be applied, the daemon is capable of re-executing itself while keeping all file descriptors open. This can be diff --git a/docs/drvesx.html.in b/docs/drvesx.html.in index 3acb7e5c51..c56da16f57 100644 --- a/docs/drvesx.html.in +++ b/docs/drvesx.html.in @@ -221,7 +221,7 @@ vpx://example-vcenter.com/folder1/dc1/folder2/example-esx.com using the CA certificate pool installed on your client computer. With an out-of-the-box installed ESX server this won't work, because a newly installed ESX server uses auto-generated self-signed certificates. - Those are singed by a CA certificate that is typically not known to your + Those are signed by a CA certificate that is typically not known to your client computer and libvirt will report an error like this one: </p> <pre> @@ -322,9 +322,9 @@ error: invalid argument in libvirt was built without the 'esx' driver </p> - <h2><a id="xmlspecial">Specialties in the domain XML config</a></h2> + <h2><a id="xmlspecial">Specialities in the domain XML config</a></h2> <p> - There are several specialties in the domain XML config for ESX domains. + There are several specialities in the domain XML config for ESX domains. </p> <h3><a id="restrictions">Restrictions</a></h3> diff --git a/docs/drvxen.html.in b/docs/drvxen.html.in index 45a9329fcf..da94952e42 100644 --- a/docs/drvxen.html.in +++ b/docs/drvxen.html.in @@ -154,7 +154,7 @@ vif = [ "mac=00:16:3e:60:36:ba,bridge=virbr0,script=vif-bridge,vifname=vif5.0" ] <code>&lt;xen:commandline&gt;</code> describing each argument passed to the device model when starting the domain. </p> - <p>The following example illustrates passing agruments to the QEMU device + <p>The following example illustrates passing arguments to the QEMU device model that define a floppy drive, which Xen does not support through its public APIs: </p> diff --git a/docs/format.html.in b/docs/format.html.in index d013528fe0..1d2456de6f 100644 --- a/docs/format.html.in +++ b/docs/format.html.in @@ -35,7 +35,7 @@ <p> The <code>virt-xml-validate</code> tool provides a simple command line for validating XML documents prior to giving them to libvirt. It uses - the locally instaled RNG schema documents. It will auto-detect which + the locally installed RNG schema documents. It will auto-detect which schema to use for validation based on the name of the top level element in the input document. Thus it merely requires the XML document filename to be passed on the command line diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index f3cf9e1fb3..0930d09c5e 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -45,7 +45,7 @@ General metadata ``name`` The content of the ``name`` element provides a short name for the virtual - machine. This name should consist only of alpha-numeric characters and is + machine. This name should consist only of alphanumeric characters and is required to be unique within the scope of a single host. It is often used to form the filename for storing the persistent configuration file. :since:`Since 0.0.1` @@ -804,7 +804,7 @@ CPU Tuning ``vcpusched``, ``iothreadsched`` and ``emulatorsched`` The optional ``vcpusched``, ``iothreadsched`` and ``emulatorsched`` elements specify the scheduler type (values ``batch``, ``idle``, ``fifo``, ``rr``) for - particular vCPU, IOThread and emulator threads respecively. For ``vcpusched`` + particular vCPU, IOThread and emulator threads respectively. For ``vcpusched`` and ``iothreadsched`` the attributes ``vcpus`` and ``iothreads`` select which vCPUs/IOThreads this setting applies to, leaving them out sets the default. The element ``emulatorsched`` does not have that attribute. Valid ``vcpus`` @@ -4422,7 +4422,7 @@ Generic ethernet connection ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Provides a means to use a new or existing tap device (or veth device pair, -depening on the needs of the hypervisor driver) that is partially or wholly +depending on the needs of the hypervisor driver) that is partially or wholly setup external to libvirt (either prior to the guest starting, or while the guest is being started via an optional script specified in the config). diff --git a/docs/formatdomaincaps.html.in b/docs/formatdomaincaps.html.in index 1506f79818..65ab5574d3 100644 --- a/docs/formatdomaincaps.html.in +++ b/docs/formatdomaincaps.html.in @@ -152,7 +152,7 @@ values for which a firmware "descriptor file" exists on the host. Firmware descriptor file is a small JSON document that describes details about a given BIOS or UEFI binary on the host, e.g. the - fimware binary path, its architecture, supported machine types, + firmware binary path, its architecture, supported machine types, NVRAM template, etc. This ensures that the reported values won't cause a failure on guest boot. </p> diff --git a/docs/formatnetwork.html.in b/docs/formatnetwork.html.in index 94a4cab4d1..f26909bec8 100644 --- a/docs/formatnetwork.html.in +++ b/docs/formatnetwork.html.in @@ -48,7 +48,7 @@ <dt><code>name</code></dt> <dd>The content of the <code>name</code> element provides a short name for the virtual network. This name should - consist only of alpha-numeric characters and is required + consist only of alphanumeric characters and is required to be unique within the scope of a single host. It is used to form the filename for storing the persistent configuration file. <span class="since">Since 0.3.0</span></dd> @@ -1249,7 +1249,7 @@ above) which you can use at will.</p> <p>Many operating systems will not consider these addresses as - preferential to IPv4, due to some practial history of these + preferential to IPv4, due to some practical history of these addresses being present but unroutable and causing networking issues. On many Linux distributions, you may need to override <tt>/etc/gai.conf</tt> with values diff --git a/docs/formatnode.html.in b/docs/formatnode.html.in index 4c7de50a0b..594427468b 100644 --- a/docs/formatnode.html.in +++ b/docs/formatnode.html.in @@ -145,7 +145,7 @@ device's sysfs directory) the capability element will also have an attribute named <code>maxCount</code> which is the maximum number of SRIOV VFs supported by this device, which - could be higher than the number of VFs that are curently + could be higher than the number of VFs that are currently active <span class="since">since 1.3.0</span>; in this case, even if there are currently no active VFs the virtual_functions capabililty will still be shown. diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 8eee7ccf9e..cac44503da 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -356,7 +356,7 @@ which of the scsi_host adapters for the provided PCI address should be used. The value is determine by contents of the <code>unique_id</code> file for the specific scsi_host adapter. - For a PCI address of "0000:00:1f:2", the unique identifer files + For a PCI address of "0000:00:1f:2", the unique identifier files can be found using the command <code>find -H /sys/class/scsi_host/host*/unique_id | xargs grep '[0-9]'</code>. Optionally, the diff --git a/docs/formatstoragecaps.html.in b/docs/formatstoragecaps.html.in index d8a1cacd96..900303aef7 100644 --- a/docs/formatstoragecaps.html.in +++ b/docs/formatstoragecaps.html.in @@ -64,7 +64,7 @@ &lt;/storagepoolCapabilities&gt; </pre> - <p>The following section decribes subelements of the + <p>The following section describes subelements of the <code>poolOptions</code> and <code>volOptions</code> subelements </p>: <dl> diff --git a/docs/hooks.html.in b/docs/hooks.html.in index a38ba05522..bbbc414dc4 100644 --- a/docs/hooks.html.in +++ b/docs/hooks.html.in @@ -203,7 +203,7 @@ <code>/etc/libvirt/hooks/qemu.d/</code>. They are executed in alphabetical order after main script. In this case each script also acts as filter and can modify the domain XML and print it out on - its standart output. This script output is passed to standard input + its standard output. This script output is passed to standard input next script in order. Empty output from any script is also identical to copying the input XML without changing it. In case any script returns failure common process will be aborted, @@ -296,7 +296,7 @@ <code>/etc/libvirt/hooks/libxl.d/</code>. They are executed in alphabetical order after main script. In this case each script also acts as filter and can modify the domain XML and print it out on - its standart output. This script output is passed to standard input + its standard output. This script output is passed to standard input next script in order. Empty output from any script is also identical to copying the input XML without changing it. In case any script returns failure common process will be aborted, diff --git a/docs/kbase/backing_chains.rst b/docs/kbase/backing_chains.rst index c3de37f4d1..89920a61b1 100644 --- a/docs/kbase/backing_chains.rst +++ b/docs/kbase/backing_chains.rst @@ -186,7 +186,7 @@ of the following criteria is met: - ``backing file`` is present AND is correct/trusted Note that the last criterion may require manual inspection and thus should not -be scripted unless the trust for the image can be expressed programatically. +be scripted unless the trust for the image can be expressed programmatically. Also note that the above steps may need to be repeated recursively for any subsequent backing images. diff --git a/docs/kbase/debuglogs.rst b/docs/kbase/debuglogs.rst index 956ebc6af9..7945cf8bed 100644 --- a/docs/kbase/debuglogs.rst +++ b/docs/kbase/debuglogs.rst @@ -163,10 +163,10 @@ explicitly stated, these work on libvirt 4.4.0 and later. Please note that some of the filters below may not log enough information for filing a proper libvirt bug. Usually it's better to log more than less. -Targetted logging for debugging QEMU VMs -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Targeted logging for debugging QEMU VMs +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Specifying only some sections allows for a targetted filter configuration which +Specifying only some sections allows for a targeted filter configuration which works on all versions and is sufficient for most cases. :: diff --git a/docs/kbase/kvm-realtime.rst b/docs/kbase/kvm-realtime.rst index 2e1541cb4d..476e581a2a 100644 --- a/docs/kbase/kvm-realtime.rst +++ b/docs/kbase/kvm-realtime.rst @@ -137,7 +137,7 @@ do not include any CPU affinity at this stage: The guest CPUs now need to be placed individually. In this case, they will all be put within the same host socket, such that they can be exposed as core -siblings. This is achieved using the `CPU tunning config <../formatdomain.html#elementsCPUTuning>`_: +siblings. This is achieved using the `CPU tuning config <../formatdomain.html#elementsCPUTuning>`_: :: diff --git a/docs/kbase/migrationinternals.rst b/docs/kbase/migrationinternals.rst index 29bda0443b..2e187936a7 100644 --- a/docs/kbase/migrationinternals.rst +++ b/docs/kbase/migrationinternals.rst @@ -25,7 +25,7 @@ In this document, unless stated otherwise, these conventions are followed: any host; * 'regular migration' refers to any migration operation where the libvirt - client co-ordinates the communication between the libvirtd instances in + client coordinates the communication between the libvirtd instances in the source and destination hosts. Migration protocol diff --git a/docs/kbase/rpm-deployment.rst b/docs/kbase/rpm-deployment.rst index 8f1584d7ea..568cf5b3eb 100644 --- a/docs/kbase/rpm-deployment.rst +++ b/docs/kbase/rpm-deployment.rst @@ -384,7 +384,7 @@ set of hypervisor packages too. Since this installs every possible libvirt feature for the virtualization driver in question, the on-disk footprint is quite large. The in-memory -footprint of the daemons is also relatively large since alot of code is +footprint of the daemons is also relatively large since a lot of code is loaded. diff --git a/docs/logos/README b/docs/logos/README index 888ba18798..64dee41ec8 100644 --- a/docs/logos/README +++ b/docs/logos/README @@ -38,7 +38,7 @@ format: - logo-square-powered.svg - A variant of the square logo for use by 3rd party applications, to advertize + A variant of the square logo for use by 3rd party applications, to advertise their use of libvirt. Bitmap sizes: 64, 128, 192, 256 px square diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst index ebf4f16cf7..9ac379a4b8 100644 --- a/docs/manpages/virsh.rst +++ b/docs/manpages/virsh.rst @@ -7142,7 +7142,7 @@ checkpoint-create Create a checkpoint for domain *domain* with the properties specified in *xmlfile* describing a <domaincheckpoint> top-level element. The format of the input XML file will be validated against an internal RNG -schema (idential to using the virt-xml-validate(1) tool). If +schema (identical to using the virt-xml-validate(1) tool). If *xmlfile* is completely omitted, then libvirt will create a checkpoint with a name based on the current time. diff --git a/docs/manpages/virt-login-shell.rst b/docs/manpages/virt-login-shell.rst index 3833a3e912..1e95d5d2b4 100644 --- a/docs/manpages/virt-login-shell.rst +++ b/docs/manpages/virt-login-shell.rst @@ -29,7 +29,7 @@ configured in ``/etc/libvirt/virt-login-shell.conf``. The basic structure of most ``virt-login-shell`` usage is: -.. code-block:: +.. code-block:: shell virt-login-shell @@ -58,7 +58,7 @@ By default, ``virt-login-shell`` will execute the ``/bin/sh`` program for the user. You can modify this behaviour by defining the shell variable in ``/etc/libvirt/virt-login-shell.conf``. e.g. -.. code-block:: +.. code-block:: shell shell = [ "/bin/bash" ] @@ -68,7 +68,7 @@ detect the shell from ``/etc/password`` inside the container. This should only be done if the container has a separate ``/etc`` directory from the host, otherwise it will end up recursively invoking ``virt-login-shell``. e.g. -.. code-block:: +.. code-block:: shell auto_shell = 1 @@ -77,7 +77,7 @@ By default no users are allowed to use virt-login-shell, if you want to allow certain users to use virt-login-shell, you need to modify the allowed_users variable in /etc/libvirt/virt-login-shell.conf. e.g. -.. code-block:: +.. code-block:: shell allowed_users = [ "tom", "dick", "harry" ] diff --git a/docs/schemas/basictypes.rng b/docs/schemas/basictypes.rng index 79d96451f1..33b554f8d1 100644 --- a/docs/schemas/basictypes.rng +++ b/docs/schemas/basictypes.rng @@ -167,7 +167,7 @@ <!--such as dnsmasq to assign a specific IP address (and optionally a --> <!--name to an interface. The applicable standards are RFC3315 and --> <!--RFC6355. These standards actually require the duid to be fixed for --> - <!--the hardward device and applicable to all network interfaces on --> + <!--the hardware device and applicable to all network interfaces on --> <!--that device. It is not clear that any software currently enforces --> <!--this requirement although it could be implemented manually. --> <!--====================================================================--> diff --git a/docs/schemas/domaincommon.rng b/docs/schemas/domaincommon.rng index 4b7e460148..316d93fb69 100644 --- a/docs/schemas/domaincommon.rng +++ b/docs/schemas/domaincommon.rng @@ -5580,7 +5580,7 @@ <!-- System information specification: - Placeholder for system specific informations likes the ones + Placeholder for system specific information likes the ones contained in the SMBIOS area. Only a limited subset of entries can be modified there, so we fully enumerate each case here. diff --git a/docs/securityprocess.html.in b/docs/securityprocess.html.in index 5f072c1ced..0e4802a1de 100644 --- a/docs/securityprocess.html.in +++ b/docs/securityprocess.html.in @@ -59,7 +59,7 @@ the various vendors who distribute libvirt. The team is responsible for analysing incoming reports from users to identify whether a security problem exists and its severity. It then works to produce - a fix for all official stable branches of libvirt and co-ordinate + a fix for all official stable branches of libvirt and coordinate embargo dates between vendors to allow simultaneous release of the fix by all affected parties. </p> diff --git a/docs/strategy.html.in b/docs/strategy.html.in index 0d845d006a..70b706b6de 100644 --- a/docs/strategy.html.in +++ b/docs/strategy.html.in @@ -84,7 +84,7 @@ <dt>C</dt> <dd>Large parts of the core libvirt library, daemons, and helper tools will continue to make use in the C language. Integration of other - languages will be an incremental, targetted process where they can + languages will be an incremental, targeted process where they can bring the greatest benefit.</dd> <dt>Rust / Go</dt> <dd>Parts of the core libvirt library, daemons and helper tools are to diff --git a/docs/uri.html.in b/docs/uri.html.in index e39d49c2ef..f96c2970a5 100644 --- a/docs/uri.html.in +++ b/docs/uri.html.in @@ -234,7 +234,7 @@ Note that parameter values must be </td> <td> tls </td> <td> - A vaid GNUTLS priority string + A valid GNUTLS priority string </td> </tr> <tr> -- 2.26.2