openstack/nova
Code Issues Proposed changes

Fix typos in nova docs

Browse Source 
Change-Id: I7b6f8c198aa42f5ef3f8b158308b993b040454ec
This commit is contained in:
Rajesh Tailor 2022-09-21 16:11:52 +05:30
parent 13c1450feb
commit 0fce3c03ab
27 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/ext/extra_specs.py
View File

@ -103,7 +103,7 @@ def _format_validator_help(
validator: base.ExtraSpecValidator,
summary: bool,
):
"""Generate reStucturedText snippets for the provided validator.
"""Generate reStructuredText snippets for the provided validator.
:param validator: A validator to document.
:type validator: nova.api.validation.extra_specs.base.ExtraSpecValidator

6
doc/ext/feature_matrix.py
View File

@ -69,10 +69,10 @@ class MatrixImplementation(object):
STATUS_COMPLETE = "complete"
STATUS_PARTIAL = "partial"
STATUS_MISSING = "missing"
STATUS_UKNOWN = "unknown"
STATUS_UNKNOWN = "unknown"
STATUS_ALL = [STATUS_COMPLETE, STATUS_PARTIAL, STATUS_MISSING,
STATUS_UKNOWN]
STATUS_UNKNOWN]
def __init__(self, status=STATUS_MISSING, notes=None, release=None):
"""MatrixImplementation models a cell in the matrix
@ -394,7 +394,7 @@ class FeatureMatrixDirective(rst.Directive):
impl_status = u"\u2716"
elif impl.status == MatrixImplementation.STATUS_PARTIAL:
impl_status = u"\u2714"
elif impl.status == MatrixImplementation.STATUS_UKNOWN:
elif impl.status == MatrixImplementation.STATUS_UNKNOWN:
impl_status = u"?"
implref.append(nodes.literal(

2
doc/source/admin/cells.rst
View File

@ -600,7 +600,7 @@ of ``rabbit://bob:s3kret@otherhost/nova`` when used with the above example.
The :oslo.config:option:`transport_url` option can contain an
extended syntax for the "netloc" part of the URL
(i.e. ``userA:passwordA@hostA:portA,userB:passwordB:hostB:portB``). In this
case, substitions of the form ``username1``, ``username2``, etc will be
case, substitutions of the form ``username1``, ``username2``, etc will be
honored and can be used in the template URL.
The templating of these URLs may be helpful in order to provide each service host

2
doc/source/admin/configuration/hypervisor-hyper-v.rst
View File

@ -244,7 +244,7 @@ The following packages must be installed with pip:
* ``pywin32``
* ``pymysql``
* ``greenlet``
* ``pycryto``
* ``pycrypto``
* ``ecdsa``
* ``amqp``
* ``wmi``

4
doc/source/admin/cpu-topologies.rst
View File

@ -129,9 +129,9 @@ Sorts are performed on host's NUMA nodes list in the following order:
Top sorting priority is for host's NUMA nodes with PCI devices attached. If VM
requested PCI device(s) logic **always** puts host's NUMA nodes with more PCI
devices at the beginnig of the host's NUMA nodes list. If PCI devices isn't
devices at the beginning of the host's NUMA nodes list. If PCI devices isn't
requested by VM than NUMA nodes with no (or less) PCI device available will be
placed at the beginnig of the list.
placed at the beginning of the list.
.. caution::

2
doc/source/admin/index.rst
View File

@ -99,7 +99,7 @@ the defaults from the :doc:`install guide </install/index>` will be sufficient.
cells allow sharding of your compute environment. Upfront planning is key to
a successful cells v2 layout.
* :doc:`Availablity Zones </admin/availability-zones>`: Availability Zones are
* :doc:`Availability Zones </admin/availability-zones>`: Availability Zones are
an end-user visible logical abstraction for partitioning a cloud without
knowing the physical infrastructure.

2
doc/source/admin/libvirt-misc.rst
View File

@ -149,7 +149,7 @@ Locked memory allocation
Locking memory marks the guest memory allocations as unmovable and
unswappable. It is implicitly enabled in a number of cases such as SEV or
realtime guests but can also be enabled explictly using the
realtime guests but can also be enabled explicitly using the
``hw:locked_memory`` extra spec (or use ``hw_locked_memory`` image property).
``hw:locked_memory`` (also ``hw_locked_memory`` image property) accept
boolean values in string format like 'true' or 'false' value.

6
doc/source/admin/manage-volumes.rst
View File

@ -188,9 +188,9 @@ fetched using the `volume_attachment get_connector` subcommand:
.. note::
Future work will remove this requirement and incorperate the gathering of
the host connector into the main refresh command. Unfortunatley until then
it must remain a seperate manual step.
Future work will remove this requirement and incorporate the gathering of
the host connector into the main refresh command. Unfortunately until then
it must remain a separate manual step.
We can then provide this connector to the `volume_attachment refresh`
subcommand. This command will connect to the compute, disconnect any host

2
doc/source/admin/managing-resource-providers.rst
View File

@ -158,7 +158,7 @@ Schema Example
items:
patternProperties:
# Allows any key name matching the resource class pattern,
# check to prevent conflicts with virt driver owned resouces classes
# check to prevent conflicts with virt driver owned resources classes
# will be done after schema validation.
^[A-Z0-9_]{1,255}$:
type: object

2
doc/source/admin/networking.rst
View File

@ -70,7 +70,7 @@ A full guide on configuring and using SR-IOV is provided in the
(see, for example, `this bug <https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1957753>`_
which discusses a case relevant to one driver). As of Libvirt v8.1.0,
EPERM errors encountered while programming VLAN 0 are ignored if
VLAN clearning is not explicitly requested in the device XML (i.e.
VLAN clearing is not explicitly requested in the device XML (i.e.
VLAN 0 is not specified explicitly).
NUMA Affinity

4
doc/source/admin/pci-passthrough.rst
View File

@ -219,7 +219,7 @@ have special meaning:
result in an error depending on your driver and kernel version (see, for
example, `this bug <https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1957753>`_
which discusses a case relevant to one driver). As of Libvirt v8.1.0, EPERM
errors encountered while programming a VLAN are ignored if VLAN clearning is
errors encountered while programming a VLAN are ignored if VLAN clearing is
not explicitly requested in the device XML.
``trusted``
@ -456,7 +456,7 @@ and OS allows, we can enable vIOMMU in libvirt driver.
.. note::
Enable vIOMMU might introduce significant performance overhead.
You can see performance comparision table from
You can see performance comparison table from
`AMD vIOMMU session on KVM Forum 2021`_.
For the above reason, vIOMMU should only be enabled for workflow that
require it.

2
doc/source/admin/scheduling.rst
View File

@ -1162,7 +1162,7 @@ here.
:oslo.config:option:`DEFAULT.cpu_allocation_ratio`,
:oslo.config:option:`DEFAULT.ram_allocation_ratio` or
:oslo.config:option:`DEFAULT.disk_allocation_ratio` to a non-null value
would ensure the user-configured value was always overriden.
would ensure the user-configured value was always overridden.
.. _osc-placement: https://docs.openstack.org/osc-placement/latest/index.html

4
doc/source/admin/secure-live-migration-with-qemu-native-tls.rst
View File

@ -186,8 +186,8 @@ Related information
any other ``*_tls*`` parameters, _unless_ you need different
certificates for some services. The rationale for that is that some
services (e.g. migration / NBD) are only exposed to internal
infrastructure; while some sevices (VNC, Spice) might be exposed
publically, so might need different certificates. For OpenStack this
infrastructure; while some services (VNC, Spice) might be exposed
publicly, so might need different certificates. For OpenStack this
does not matter, though, we will stick with the defaults.
- If they are not already open, ensure you open up these TCP ports on

2
doc/source/cli/nova-manage.rst
View File

@ -1607,7 +1607,7 @@ instance changing when moving between machine types.
.. option:: --force
Skip machine type compatability checks and force machine type update.
Skip machine type compatibility checks and force machine type update.
.. rubric:: Return codes

2
doc/source/cli/nova-rootwrap.rst
View File

@ -9,7 +9,7 @@ Synopsis
::
nova-rootwrap CONFIG_FILE COMMMAND
nova-rootwrap CONFIG_FILE COMMAND
Description
===========

4
doc/source/configuration/index.rst
View File

@ -48,7 +48,7 @@ services and what configuration options are available can be found below.
.. # NOTE(mriedem): This is the section where we hide things that we don't
# actually want in the table of contents but sphinx build would fail if
# they aren't in the toctree somewhere.
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
@ -100,7 +100,7 @@ policies are available can be found below.
.. # NOTE(mriedem): This is the section where we hide things that we don't
# actually want in the table of contents but sphinx build would fail if
# they aren't in the toctree somewhere.
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:

2
doc/source/configuration/policy-concepts.rst
View File

@ -231,7 +231,7 @@ defaulted to below rules:
With these new defaults, you can solve the problem of:
#. Providing the read-only access to the user. Polices are made more granular
and defaulted to reader rules. For exmaple: If you need to let someone audit
and defaulted to reader rules. For example: If you need to let someone audit
your deployment for security purposes.
#. Customize the policy in better way. For example, you will be able

2
doc/source/contributor/api-ref-guideline.rst
View File

@ -351,7 +351,7 @@ In the parameter file, define the ``required`` field in each parameter.
but does not appear when non-admin users call.
If a parameter must be specified in the request or always appears
in the response in the micoversion added or later,
in the response in the microversion added or later,
the parameter must be defined as required (``true``).
Microversion

12
doc/source/contributor/index.rst
View File

@ -22,7 +22,7 @@ Getting Started
* :doc:`/contributor/development-environment`: Get your computer setup to
contribute
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
@ -60,7 +60,7 @@ while keeping users happy and keeping developers productive.
* :doc:`/contributor/ptl-guide`: A chronological PTL reference guide
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
@ -86,7 +86,7 @@ Reviewing
* :doc:`/contributor/documentation`: Guidelines for handling documentation
contributions
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
@ -120,7 +120,7 @@ be Python code. All new code needs to be validated somehow.
* :doc:`/contributor/testing/eventlet-profiling`
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
@ -152,7 +152,7 @@ extend.
* :doc:`/contributor/notifications`: How to add your own notifications
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
@ -176,7 +176,7 @@ diving in.
* :doc:`/contributor/resize-and-cold-migrate`: Describes the differences and
similarities between resize and cold migrate operations.
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:

12
doc/source/index.rst
View File

@ -49,7 +49,7 @@ For End Users
As an end user of nova, you'll use nova to create and manage servers with
either tools or the API directly.
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
@ -110,7 +110,7 @@ Architecture Overview
* :doc:`Nova architecture </admin/architecture>`: An overview of how all the parts in
nova fit together.
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
@ -128,7 +128,7 @@ having installed :keystone-doc:`keystone <install/>`, :glance-doc:`glance
:placement-doc:`placement <install/>`. Ensure that you follow their install
guides first.
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:maxdepth: 2
@ -192,7 +192,7 @@ Once you are running nova, the following information is extremely useful.
instances (either via metadata server or config drive) for your specific
purposes.
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
@ -211,7 +211,7 @@ Reference Material
* :doc:`Configuration Guide <configuration/index>`: Information on configuring
the system, including role-based access control policy rules.
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
@ -230,7 +230,7 @@ For Contributors
both current and future looking parts of our architecture.
These are collected here.
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:

2
doc/source/reference/attach-volume.rst
View File

@ -22,7 +22,7 @@ the optional interactions with the ``os-brick`` library on the compute hosts
during the request.
.. note:: ``os-brick`` is not always used to connect volumes to the host, most
notibly when connecting an instance natively to ceph ``rbd`` volumes
notably when connecting an instance natively to ceph ``rbd`` volumes
The diagram also outlines the various locks taken on the compute during the
attach volume flow. In this example these include locks against the

2
doc/source/reference/glossary.rst
View File

@ -26,7 +26,7 @@ Glossary
Cell
A cell is a shard or horizontal partition in a nova deployment.
A cell mostly consists of a database, queue, and set of compute nodes.
All deployments willl have at least one cell (and one "fake" cell).
All deployments will have at least one cell (and one "fake" cell).
Larger deployments can have many.
For more information, refer to :doc:`/admin/cells`.

8
doc/source/reference/index.rst
View File

@ -44,7 +44,7 @@ The following is a dive into some of the internals in nova.
* :doc:`/reference/libvirt-distro-support-matrix`: Libvirt virt driver OS
distribution support matrix
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
@ -73,7 +73,7 @@ Debugging
* :doc:`/reference/gmr`: Inspired by Amiga, a way to trigger a very
comprehensive dump of a running service for deep debugging.
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
@ -97,7 +97,7 @@ these are a great place to start reading up on the current plans.
* :doc:`/reference/scheduler-evolution`: Motivation behind the scheduler /
placement evolution
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:
@ -112,7 +112,7 @@ Additional Information
* :doc:`/reference/glossary`: A quick reference guide to some of the terms you
might encounter working on or using nova.
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
.. # NOTE(amotoki): toctree needs to be placed at the end of the section to
# keep the document structure in the PDF doc.
.. toctree::
:hidden:

2
doc/source/reference/libvirt-distro-support-matrix.rst
View File

@ -180,7 +180,7 @@ OS distribution versions
------------------------
This table provides information on a representative sample of OS distros and
the version of libirt/QEMU/libguestfs that they ship. This is **NOT** intended
the version of libvirt/QEMU/libguestfs that they ship. This is **NOT** intended
to be an exhaustive list of distros where OpenStack Nova can run - it is
intended to run on any Linux distro that can satisfy the minimum required
software versions. This table merely aims to help identify when minimum

2
doc/source/reference/stable-api.rst
View File

@ -29,7 +29,7 @@ Background
Nova used to include two distinct frameworks for exposing REST API
functionality. Older code is called the "v2 API" and existed in the
/nova/api/openstack/compute/legacy_v2/ directory. This code tree was totally
removed during Netwon release time frame (14.0.0 and later).
removed during Newton release time frame (14.0.0 and later).
Newer code is called the "v2.1 API" and exists in the
/nova/api/openstack/compute directory.

2
doc/source/user/block-device-mapping.rst
View File

@ -49,7 +49,7 @@ When we talk about block device mapping, we usually refer to one of two things
on.
For more details on this please refer to the :doc:`Driver BDM Data
Structures <../reference/block-device-structs>` refernce document.
Structures <../reference/block-device-structs>` reference document.
.. note::

4
doc/source/user/certificate-validation.rst
View File

@ -309,7 +309,7 @@ Create the first intermediate certificate
"""""""""""""""""""""""""""""""""""""""""
Create a certificate request for the first intermediate certificate. For these
instructions, we will save the certificate request as
``cert_intermeidate_a.csr`` and the private key as ``key_intermediate_a.pem``.
``cert_intermediate_a.csr`` and the private key as ``key_intermediate_a.pem``.
.. code-block:: console
@ -357,7 +357,7 @@ Create the second intermediate certificate
""""""""""""""""""""""""""""""""""""""""""
Create a certificate request for the second intermediate certificate. For these
instructions, we will save the certificate request as
``cert_intermeidate_b.csr`` and the private key as ``key_intermediate_b.pem``.
``cert_intermediate_b.csr`` and the private key as ``key_intermediate_b.pem``.
.. code-block:: console