From 2fe68f322a9829e3a578ea90b0bf98416af82ba3 Mon Sep 17 00:00:00 2001 From: John McNamara Date: Tue, 15 Dec 2015 09:38:59 +0000 Subject: [PATCH] doc: fix spellings Fix various spellings in rst docs. Signed-off-by: John McNamara Acked-by: Harry van Haaren --- doc/guides/contributing/coding_style.rst | 2 +- doc/guides/contributing/versioning.rst | 2 +- doc/guides/cryptodevs/aesni_mb.rst | 2 +- doc/guides/nics/bnx2x.rst | 6 +++--- doc/guides/nics/nfp.rst | 2 +- doc/guides/nics/szedata2.rst | 4 ++-- doc/guides/prog_guide/env_abstraction_layer.rst | 2 +- doc/guides/prog_guide/hash_lib.rst | 2 +- .../prog_guide/link_bonding_poll_mode_drv_lib.rst | 2 +- doc/guides/prog_guide/overview.rst | 2 +- doc/guides/prog_guide/packet_framework.rst | 12 ++++++------ doc/guides/rel_notes/release_1_8.rst | 2 +- doc/guides/sample_app_ug/performance_thread.rst | 2 +- doc/guides/sample_app_ug/tep_termination.rst | 2 +- doc/guides/sample_app_ug/test_pipeline.rst | 6 +++--- 15 files changed, 25 insertions(+), 25 deletions(-) diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst index 22f26dd935..ad1392d2e4 100644 --- a/doc/guides/contributing/coding_style.rst +++ b/doc/guides/contributing/coding_style.rst @@ -461,7 +461,7 @@ Local Variables * When declaring variables in functions, multiple variables per line are OK. However, if multiple declarations would cause the line to exceed a reasonable line length, begin a new set of declarations on the next line rather than using a line continuation. * Be careful to not obfuscate the code by initializing variables in the declarations, only the last variable on a line should be initialized. - If multiple variables are to be initialised when defined, put one per line. + If multiple variables are to be initialized when defined, put one per line. * Do not use function calls in initializers, except for ``const`` variables. .. code-block:: c diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst index d69a5c3ab3..ae10a984ca 100644 --- a/doc/guides/contributing/versioning.rst +++ b/doc/guides/contributing/versioning.rst @@ -261,7 +261,7 @@ with the public symbol name struct rte_acl_ctx *ctx; ... -Note that the base name of the symbol was kept intact, as this is condusive to +Note that the base name of the symbol was kept intact, as this is conducive to the macros used for versioning symbols. That is our next step, mapping this new symbol name to the initial symbol name at version node 2.0. Immediately after the function, we add this line of code diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst index 2ff5c418ca..0f4b920620 100644 --- a/doc/guides/cryptodevs/aesni_mb.rst +++ b/doc/guides/cryptodevs/aesni_mb.rst @@ -32,7 +32,7 @@ AESN-NI Multi Buffer Crytpo Poll Mode Driver The AESNI MB PMD (**librte_pmd_aesni_mb**) provides poll mode crypto driver -support for utilising Intel multi buffer library, see the white paper +support for utilizing Intel multi buffer library, see the white paper `Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors `_. diff --git a/doc/guides/nics/bnx2x.rst b/doc/guides/nics/bnx2x.rst index 85ac1c3c24..ed0e5e5771 100644 --- a/doc/guides/nics/bnx2x.rst +++ b/doc/guides/nics/bnx2x.rst @@ -81,7 +81,7 @@ Supported QLogic NICs Prerequisites ------------- -- Requires firmware version **7.2.51.0**. It is inbox on most of the +- Requires firmware version **7.2.51.0**. It is included in most of the standard Linux distros. If it is not available visit `QLogic Driver Download Center `_ to get the required firmware. @@ -313,7 +313,7 @@ This section provides instructions to configure SR-IOV with Linux OS. #. Assign VF MAC address: - Assign MAC address to the VF using iproute2 ulility. The syntax is: + Assign MAC address to the VF using iproute2 utility. The syntax is: ip link set vf mac Example output: @@ -323,7 +323,7 @@ This section provides instructions to configure SR-IOV with Linux OS. ip link set ens5f0 vf 0 mac 52:54:00:2f:9d:e8 -#. PCI passthrough: +#. PCI Passthrough: The VF devices may be passed through to the guest VM using virt-manager or virsh etc. bnx2x PMD should be used to bind the VF devices in the guest VM diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst index 55ba64d459..dfc368368c 100644 --- a/doc/guides/nics/nfp.rst +++ b/doc/guides/nics/nfp.rst @@ -126,7 +126,7 @@ Using the NFP PMD is not different to using other PMDs. Usual steps are: cat /sys/kernel/mm/hugepages/hugepages-2048kB/free_hugepages - The hugepages reservation should be performed at system initialisation and + The hugepages reservation should be performed at system initialization and it is usual to use a kernel parameter for configuration. If the reservation is attempted on a busy system it will likely fail. Reserving memory for hugepages may be done adding the following to the grub kernel command line: diff --git a/doc/guides/nics/szedata2.rst b/doc/guides/nics/szedata2.rst index e093704cd5..ee3c3fe653 100644 --- a/doc/guides/nics/szedata2.rst +++ b/doc/guides/nics/szedata2.rst @@ -54,8 +54,8 @@ found on the `Liberouter website `_. Currently the driver is supported only on x86_64 architectures. Only x86_64 versions of the external libraries are provided. -Prerequisities --------------- +Prerequisites +------------- This PMD requires kernel modules which are responsible for initialization and allocation of resources needed for sze2 layer function. diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst index a03e40d7fb..89feb692bd 100644 --- a/doc/guides/prog_guide/env_abstraction_layer.rst +++ b/doc/guides/prog_guide/env_abstraction_layer.rst @@ -555,7 +555,7 @@ The most important fields in the structure and how they are used are described b Memory Allocation ^^^^^^^^^^^^^^^^^ -On EAL initialisation, all memsegs are setup as part of the malloc heap. +On EAL initialization, all memsegs are setup as part of the malloc heap. This setup involves placing a dummy structure at the end with ``BUSY`` state, which may contain a sentinel value if ``CONFIG_RTE_MALLOC_DEBUG`` is enabled, and a proper :ref:`element header` with ``FREE`` at the start diff --git a/doc/guides/prog_guide/hash_lib.rst b/doc/guides/prog_guide/hash_lib.rst index 466c482858..8f2cdbf731 100644 --- a/doc/guides/prog_guide/hash_lib.rst +++ b/doc/guides/prog_guide/hash_lib.rst @@ -128,7 +128,7 @@ is carried out. If there is no match there either, key is considered not to be i Example of addition: -Like lookup, the primary and secondary buckets are indentified. If there is an empty slot in +Like lookup, the primary and secondary buckets are identified. If there is an empty slot in the primary bucket, primary and secondary signatures are stored in that slot, key and data (if any) are added to the second table and an index to the position in the second table is stored in the slot of the first table. If there is no space in the primary bucket, one of the entries on that bucket is pushed to its alternative location, diff --git a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst b/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst index 46f0296e2d..d523ac2812 100644 --- a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst +++ b/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst @@ -185,7 +185,7 @@ Bonding device stores its own version of RSS settings i.e. RETA, RSS hash function and RSS key, used to set up its slaves. That let to define the meaning of RSS configuration of bonding device as desired configuration of whole bonding (as one unit), without pointing any of slave inside. It is required to ensure -consistency and made it more errorproof. +consistency and made it more error-proof. RSS hash function set for bonding device, is a maximal set of RSS hash functions supported by all bonded slaves. RETA size is a GCD of all its RETA's sizes, so diff --git a/doc/guides/prog_guide/overview.rst b/doc/guides/prog_guide/overview.rst index 5d378e50ea..68cc75cc19 100644 --- a/doc/guides/prog_guide/overview.rst +++ b/doc/guides/prog_guide/overview.rst @@ -112,7 +112,7 @@ The services provided by the EAL are: * Alarm operations -* Memory managenent (malloc) +* Memory management (malloc) The EAL is fully described in :ref:`Environment Abstraction Layer `. diff --git a/doc/guides/prog_guide/packet_framework.rst b/doc/guides/prog_guide/packet_framework.rst index 381f3203e2..fbf2fe4c6c 100644 --- a/doc/guides/prog_guide/packet_framework.rst +++ b/doc/guides/prog_guide/packet_framework.rst @@ -454,7 +454,7 @@ The possible options are: .. _table_qos_23: -.. table:: Configuration Parameters Specific to Extendible Bucket Hash Table +.. table:: Configuration Parameters Specific to Extendable Bucket Hash Table +---+---------------------------+--------------------------------------------------+ | # | Parameter | Details | @@ -576,7 +576,7 @@ either with pre-computed signature or "do-sig"). | | | | | | +---+-------------------------+------------------------------+---------------------------+-------------------------------+ | 2 | Bucket extensions array | n_buckets_ext (configurable) | 32 | This array is only created | - | | | | | for extendible bucket tables. | + | | | | | for extendable bucket tables. | | | | | | | +---+-------------------------+------------------------------+---------------------------+-------------------------------+ | 3 | Key array | n_keys | key_size (configurable) | Keys added to the hash table. | @@ -601,7 +601,7 @@ either with pre-computed signature or "do-sig"). | | | | Entry 0 stores the index (0 .. 3) of the MRU key, while entry 3 | | | | | stores the index of the LRU key. | | | | | | - | | | | For extendible bucket tables, this field represents the next | + | | | | For extendable bucket tables, this field represents the next | | | | | pointer (i.e. the pointer to the next group of 4 keys linked to | | | | | the current bucket). The next pointer is not NULL if the bucket | | | | | is currently extended or NULL otherwise. | @@ -864,7 +864,7 @@ Single Key Size Hash Tables | | | | | | +---+-------------------------+------------------------------+----------------------+------------------------------------+ | 2 | Bucket extensions array | n_buckets_ext (configurable) | *8-byte key size:* | This array is only created for | - | | | | | extendible bucket tables. | + | | | | | extendable bucket tables. | | | | | | | | | | | 64 + 4 x entry_size | | | | | | | | @@ -885,7 +885,7 @@ Single Key Size Hash Tables +===+===============+====================+===============================================================================+ | 1 | Valid | 8 | Bit X (X = 0 .. 3) is set to 1 if key X is valid or to 0 otherwise. | | | | | | - | | | | Bit 4 is only used for extendible bucket tables to help with the | + | | | | Bit 4 is only used for extendable bucket tables to help with the | | | | | implementation of the branchless logic. In this case, bit 4 is set to 1 if | | | | | next pointer is valid (not NULL) or to 0 otherwise. | | | | | | @@ -894,7 +894,7 @@ Single Key Size Hash Tables | | | | stored as array of 4 entries of 2 bytes each. Entry 0 stores the index | | | | | (0 .. 3) of the MRU key, while entry 3 stores the index of the LRU key. | | | | | | - | | | | For extendible bucket tables, this field represents the next pointer (i.e. | + | | | | For extendable bucket tables, this field represents the next pointer (i.e. | | | | | the pointer to the next group of 4 keys linked to the current bucket). The | | | | | next pointer is not NULL if the bucket is currently extended or NULL | | | | | otherwise. | diff --git a/doc/guides/rel_notes/release_1_8.rst b/doc/guides/rel_notes/release_1_8.rst index 39e661186b..dd36e7d79b 100644 --- a/doc/guides/rel_notes/release_1_8.rst +++ b/doc/guides/rel_notes/release_1_8.rst @@ -59,6 +59,6 @@ New Features * Support configuring hash functions - * Support for VXLAN packet on Intel® 40GbE Controllers + * Support for VXLAN packet on Intel 40GbE Controllers * Packet Distributor Sample Application diff --git a/doc/guides/sample_app_ug/performance_thread.rst b/doc/guides/sample_app_ug/performance_thread.rst index d71bb844c2..d7d9b0842d 100644 --- a/doc/guides/sample_app_ug/performance_thread.rst +++ b/doc/guides/sample_app_ug/performance_thread.rst @@ -1248,7 +1248,7 @@ The lthread reference value is passed back in all subsequent event callbacks, the mutex and APIs are provided to retrieve the reference value from mutexes and condition variables. This enables a user to monitor, count, or filter for specific events, on specific objects, for example to monitor for a -specific thread signalling a specific condition variable, or to monitor +specific thread signaling a specific condition variable, or to monitor on all timer events, the possibilities and combinations are endless. The callback function can be set by calling the function diff --git a/doc/guides/sample_app_ug/tep_termination.rst b/doc/guides/sample_app_ug/tep_termination.rst index 6beb6f6b1f..71a4acd605 100644 --- a/doc/guides/sample_app_ug/tep_termination.rst +++ b/doc/guides/sample_app_ug/tep_termination.rst @@ -269,7 +269,7 @@ The default value is 0, which means the checksum offload is disabled. user@target:~$ ./build/app/tep_termination -c f -n 4 --huge-dir /mnt/huge -- --nb-devices 2 --tx-checksum -**TCP segment sise.** +**TCP segment size.** The tso-segsz option specifies the TCP segment size for TSO offload for tunneling packet. The default value is 0, which means TSO offload is disabled. diff --git a/doc/guides/sample_app_ug/test_pipeline.rst b/doc/guides/sample_app_ug/test_pipeline.rst index cd0cf9eea1..fd28813995 100644 --- a/doc/guides/sample_app_ug/test_pipeline.rst +++ b/doc/guides/sample_app_ug/test_pipeline.rst @@ -151,7 +151,7 @@ For hash tables, the following parameters can be selected: | | | | [destination IPv4 address, 4 bytes of 0] | | | | | | +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ - | 4 | hash-[spec]-8-ext | Extendible bucket hash table with 8-byte key size | Same as hash-[spec]-8-lru table entries, above. | + | 4 | hash-[spec]-8-ext | Extendable bucket hash table with 8-byte key size | Same as hash-[spec]-8-lru table entries, above. | | | | and 16 million entries. | | | | | | | +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ @@ -174,7 +174,7 @@ For hash tables, the following parameters can be selected: | | | | [destination IPv4 address, 12 bytes of 0] | | | | | | +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ - | 6 | hash-[spec]-16-ext | Extendible bucket hash table with 16-byte key size | Same as hash-[spec]-16-lru table entries, above. | + | 6 | hash-[spec]-16-ext | Extendable bucket hash table with 16-byte key size | Same as hash-[spec]-16-lru table entries, above. | | | | and 16 million entries. | | | | | | | +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ @@ -197,7 +197,7 @@ For hash tables, the following parameters can be selected: | | | | [destination IPv4 address, 28 bytes of 0] | | | | | | +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ - | 8 | hash-[spec]-32-ext | Extendible bucket hash table with 32-byte key size | Same as hash-[spec]-32-lru table entries, above. | + | 8 | hash-[spec]-32-ext | Extendable bucket hash table with 32-byte key size | Same as hash-[spec]-32-lru table entries, above. | | | | and 16 million entries. | | | | | | | +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ -- 2.20.1