From mboxrd@z Thu Jan 1 00:00:00 1970 From: John McNamara Subject: =?utf-8?q?=5BPATCH=5D_doc=3A_fix_spellings_in_docs?= Date: Tue, 15 Dec 2015 09:38:59 +0000 Message-ID: <1450172339-12828-1-git-send-email-john.mcnamara@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable To: dev@dpdk.org Return-path: Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id 8F10EDE0 for ; Tue, 15 Dec 2015 10:39:04 +0100 (CET) List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Fix various spellings in rst docs. Signed-off-by: John McNamara --- 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 +- doc/guides/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/contri= buting/coding_style.rst index 22f26dd..ad1392d 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 rea= sonable line length, begin a new set of declarations on the next line rat= her 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`` variab= les. =20 .. code-block:: c diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contribu= ting/versioning.rst index d69a5c3..ae10a98 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; ... =20 -Note that the base name of the symbol was kept intact, as this is condus= ive to +Note that the base name of the symbol was kept intact, as this is conduc= ive 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/a= esni_mb.rst index 2ff5c41..0f4b920 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 =20 =20 The AESNI MB PMD (**librte_pmd_aesni_mb**) provides poll mode crypto dri= ver -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=C2=AE Architecture Pro= cessors `_. =20 diff --git a/doc/guides/nics/bnx2x.rst b/doc/guides/nics/bnx2x.rst index 85ac1c3..ed0e5e5 100644 --- a/doc/guides/nics/bnx2x.rst +++ b/doc/guides/nics/bnx2x.rst @@ -81,7 +81,7 @@ Supported QLogic NICs Prerequisites ------------- =20 -- 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-IO= V with Linux OS. =20 #. Assign VF MAC address: =20 - 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 =20 Example output: @@ -323,7 +323,7 @@ This section provides instructions to configure SR-IO= V with Linux OS. ip link set ens5f0 vf 0 mac 52:54:00:2f:9d:e8 =20 =20 -#. PCI passthrough: +#. PCI Passthrough: =20 The VF devices may be passed through to the guest VM using virt-manag= er or virsh etc. bnx2x PMD should be used to bind the VF devices in the gue= st VM diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst index 55ba64d..dfc3683 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 PMD= s. Usual steps are: =20 cat /sys/kernel/mm/hugepages/hugepages-2048kB/free_hugepages =20 - The hugepages reservation should be performed at system initialisatio= n and + The hugepages reservation should be performed at system initializatio= n and it is usual to use a kernel parameter for configuration. If the reser= vation is attempted on a busy system it will likely fail. Reserving memory f= or 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 e093704..ee3c3fe 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. =20 -Prerequisities --------------- +Prerequisites +------------- =20 This PMD requires kernel modules which are responsible for initializatio= n 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 a03e40d..89feb69 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 th= ey are used are described b Memory Allocation ^^^^^^^^^^^^^^^^^ =20 -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`` s= tate, which may contain a sentinel value if ``CONFIG_RTE_MALLOC_DEBUG`` is ena= bled, and a proper :ref:`element header` with ``FREE`` at the sta= rt diff --git a/doc/guides/prog_guide/hash_lib.rst b/doc/guides/prog_guide/h= ash_lib.rst index 466c482..8f2cdbf 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, ke= y is considered not to be i =20 Example of addition: =20 -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 sto= red in the slot of the first table. If there is no space in the primary bucket, one of the entries on that b= ucket is pushed to its alternative location, diff --git a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst b/d= oc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst index 46f0296..d523ac2 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 e= nsure -consistency and made it more errorproof. +consistency and made it more error-proof. =20 RSS hash function set for bonding device, is a maximal set of RSS hash f= unctions supported by all bonded slaves. RETA size is a GCD of all its RETA's siz= es, so diff --git a/doc/guides/prog_guide/overview.rst b/doc/guides/prog_guide/o= verview.rst index 5d378e5..68cc75c 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: =20 * Alarm operations =20 -* Memory managenent (malloc) +* Memory management (malloc) =20 The EAL is fully described in :ref:`Environment Abstraction Layer `. =20 diff --git a/doc/guides/prog_guide/packet_framework.rst b/doc/guides/prog= _guide/packet_framework.rst index 381f320..fbf2fe4 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: =20 .. _table_qos_23: =20 -.. table:: Configuration Parameters Specific to Extendible Bucket Hash T= able +.. table:: Configuration Parameters Specific to Extendable Bucket Hash T= able =20 +---+---------------------------+------------------------------------= --------------+ | # | 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_si= ze (configurable) | Keys added to the hash table. | @@ -601,7 +601,7 @@ either with pre-computed signature or "do-sig"). | | | | Entry 0 stores the inde= x (0 .. 3) of the MRU key, while entry 3 | | | | | stores the index of the= LRU key. | | | | | = | - | | | | For extendible bucket t= ables, this field represents the next | + | | | | For extendable bucket t= ables, this field represents the next | | | | | pointer (i.e. the point= er to the next group of 4 keys linked to | | | | | the current bucket). Th= e next pointer is not NULL if the bucket | | | | | is currently extended o= r NULL otherwise. | @@ -864,7 +864,7 @@ Single Key Size Hash Tables | | | | = | | +---+-------------------------+------------------------------+-------= ---------------+------------------------------------+ | 2 | Bucket extensions array | n_buckets_ext (configurable) | *8-byt= e 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 +=3D=3D=3D+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D+=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D+=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D+ | 1 | Valid | 8 | Bit X (X =3D 0 .. 3) is se= t to 1 if key X is valid or to 0 otherwise. | | | | | = | - | | | | Bit 4 is only used for ext= endible bucket tables to help with the | + | | | | Bit 4 is only used for ext= endable bucket tables to help with the | | | | | implementation of the bran= chless 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 entri= es of 2 bytes each. Entry 0 stores the index | | | | | (0 .. 3) of the MRU key, w= hile entry 3 stores the index of the LRU key. | | | | | = | - | | | | For extendible bucket tabl= es, this field represents the next pointer (i.e. | + | | | | For extendable bucket tabl= es, this field represents the next pointer (i.e. | | | | | the pointer to the next gr= oup of 4 keys linked to the current bucket). The | | | | | next pointer is not NULL i= f 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 39e6611..dd36e7d 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 =20 * Support configuring hash functions =20 - * Support for VXLAN packet on Intel=C3=82=C2=AE 40GbE Controllers + * Support for VXLAN packet on Intel 40GbE Controllers =20 * 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 d71bb84..d7d9b08 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 s= ubsequent 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. =20 The callback function can be set by calling the function diff --git a/doc/guides/sample_app_ug/tep_termination.rst b/doc/guides/sa= mple_app_ug/tep_termination.rst index 6beb6f6..71a4acd 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 offl= oad is disabled. user@target:~$ ./build/app/tep_termination -c f -n 4 --huge-dir /mnt= /huge -- --nb-devices 2 --tx-checksum =20 -**TCP segment sise.** +**TCP segment size.** =20 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/samp= le_app_ug/test_pipeline.rst index cd0cf9e..fd28813 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 sele= cted: | | | = | [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 sele= cted: | | | = | [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 sele= cted: | | | = | [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. = | = | | | | = | = | +-------+------------------------+-----------------------------------= -----------------------+-------------------------------------------------= ------+ --=20 2.5.0