diff options
Diffstat (limited to 'doc/guides/tools')
| -rw-r--r-- | doc/guides/tools/cryptoperf.rst | 22 | ||||
| -rw-r--r-- | doc/guides/tools/proc_info.rst | 2 | ||||
| -rw-r--r-- | doc/guides/tools/testbbdev.rst | 10 |
3 files changed, 17 insertions, 17 deletions
diff --git a/doc/guides/tools/cryptoperf.rst b/doc/guides/tools/cryptoperf.rst index c366af4e..2fc65441 100644 --- a/doc/guides/tools/cryptoperf.rst +++ b/doc/guides/tools/cryptoperf.rst @@ -59,7 +59,7 @@ To set on the linearization options add below definition to the **Step 3: Build the application** Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the -``dpdk-test-crypto-perf`` applcation. +``dpdk-test-crypto-perf`` application. Initially, the user must select a DPDK target to choose the correct target type and compiler options to use when building the libraries. @@ -80,7 +80,7 @@ EAL Options ~~~~~~~~~~~ The following are the EAL command-line options that can be used in conjunction -with the ``dpdk-test-crypto-perf`` applcation. +with the ``dpdk-test-crypto-perf`` application. See the DPDK Getting Started Guides for more information on these options. * ``-c <COREMASK>`` or ``-l <CORELIST>`` @@ -96,10 +96,10 @@ See the DPDK Getting Started Guides for more information on these options. Add a virtual device. -Appication Options -~~~~~~~~~~~~~~~~~~ +Application Options +~~~~~~~~~~~~~~~~~~~ -The following are the appication command-line options: +The following are the application command-line options: * ``--ptest type`` @@ -338,13 +338,13 @@ Test Vector File The test vector file is a text file contain information about test vectors. The file is made of the sections. The first section doesn't have header. It contain global information used in each test variant vectors - -typically information about plaintext, ciphertext, cipher key, aut key, +typically information about plaintext, ciphertext, cipher key, auth key, initial vector. All other sections begin header. The sections contain particular information typically digest. **Format of the file:** -Each line beginig with sign '#' contain comment and it is ignored by parser:: +Each line beginning with sign '#' contain comment and it is ignored by parser:: # <comment> @@ -352,16 +352,16 @@ Header line is just name in square bracket:: [<section name>] -Data line contain information tocken then sign '=' and +Data line contain information token then sign '=' and a string of bytes in C byte array format:: - <tocken> = <C byte array> + <token> = <C byte array> -**Tockens list:** +**Tokens list:** * ``plaintext`` - Original plaintext to be crypted. + Original plaintext to be encrypted. * ``ciphertext`` diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst index d5b5ed6a..e9a0b79d 100644 --- a/doc/guides/tools/proc_info.rst +++ b/doc/guides/tools/proc_info.rst @@ -48,7 +48,7 @@ Limitations * When running ``dpdk-procinfo`` with shared library mode, it is required to pass the same NIC PMD libraries as used for the primary application. Any - mismatch in PMD library arguments can lead to undefined behaviour and results + mismatch in PMD library arguments can lead to undefined behavior and results affecting primary application too. * Stats retrieval using ``dpdk-procinfo`` is not supported for virtual devices like PCAP and TAP. diff --git a/doc/guides/tools/testbbdev.rst b/doc/guides/tools/testbbdev.rst index 5caa9023..a8cb6fbb 100644 --- a/doc/guides/tools/testbbdev.rst +++ b/doc/guides/tools/testbbdev.rst @@ -139,7 +139,7 @@ There are 6 main test cases that can be executed using testbbdev tool: * Latency measurement [-c latency] - Measures the time consumed from the first enqueue until the first appearance of a dequeued result - - This measurment represents the full latency of a bbdev operation + - This measurement represents the full latency of a bbdev operation (encode or decode) to execute * Poll-mode Throughput measurement [-c throughput] @@ -307,7 +307,7 @@ baseband_null device does not have to be defined explicitly as it is created by Test Vector files -================= +----------------- Test Vector files contain the data which is used to set turbo decoder/encoder parameters and buffers for validation purpose. New test vector files should be @@ -316,7 +316,7 @@ the syntax of the test vector files is in the following section. Basic principles for test vector files --------------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Line started with ``#`` is treated as a comment and is ignored. If variable is a chain of values, values should be separated by a comma. If @@ -351,7 +351,7 @@ documented in *rte_bbdev_op.h* Turbo decoder test vectors template ------------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For turbo decoder it has to be always set to ``RTE_BBDEV_OP_TURBO_DEC`` @@ -528,7 +528,7 @@ Following statuses can be used: Turbo encoder test vectors template ------------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For turbo encoder it has to be always set to ``RTE_BBDEV_OP_TURBO_ENC`` |