[v2,36/37] doc: remove references to make in testpmd guides
Checks
Commit Message
Make is no longer supported for compiling DPDK, references are now
removed in the documentation.
Signed-off-by: Ciara Power <ciara.power@intel.com>
---
doc/guides/testpmd_app_ug/run_app.rst | 6 +++---
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 9 +--------
2 files changed, 4 insertions(+), 11 deletions(-)
Comments
On 20/08/2020 13:41, Ciara Power wrote:
> Make is no longer supported for compiling DPDK, references are now
> removed in the documentation.
>
> Signed-off-by: Ciara Power <ciara.power@intel.com>
> ---
> doc/guides/testpmd_app_ug/run_app.rst | 6 +++---
> doc/guides/testpmd_app_ug/testpmd_funcs.rst | 9 +--------
> 2 files changed, 4 insertions(+), 11 deletions(-)
>
<snip>
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index 90cf252df5..f0d838321c 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -71,7 +71,7 @@ practical or possible testpmd supports alternative methods for executing command
>
> .. code-block:: console
>
> - ./testpmd -n4 -r2 ... -- -i --cmdline-file=/home/ubuntu/flow-create-commands.txt
> + ./dpdk-testpmd -n4 -r2 ... -- -i --cmdline-file=/home/ubuntu/flow-create-commands.txt
> Interactive-mode selected
> CLI commands to be read from /home/ubuntu/flow-create-commands.txt
> Configuring Port 0 (socket 0)
> @@ -329,8 +329,6 @@ The available information categories are:
>
> * ``icmpecho``: Receives a burst of packets, lookup for ICMP echo requests and, if any, send back ICMP echo replies.
>
> -* ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
> -
The support for ieee1588 info is not being removed, this line should
stay in the documentation. Just remove the "CONFIG..." part.
LGTM other than that.
Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
@@ -20,7 +20,7 @@ They must be separated from the EAL options, shown in the previous section, with
.. code-block:: console
- sudo ./testpmd -l 0-3 -n 4 -- -i --portmask=0x1 --nb-cores=2
+ sudo ./dpdk-testpmd -l 0-3 -n 4 -- -i --portmask=0x1 --nb-cores=2
The command line options are:
@@ -59,13 +59,13 @@ The command line options are:
* ``--nb-cores=N``
Set the number of forwarding cores,
- where 1 <= N <= "number of cores" or ``CONFIG_RTE_MAX_LCORE`` from the configuration file.
+ where 1 <= N <= "number of cores" or ``RTE_MAX_LCORE`` from the configuration file.
The default value is 1.
* ``--nb-ports=N``
Set the number of forwarding ports,
- where 1 <= N <= "number of ports" on the board or ``CONFIG_RTE_MAX_ETHPORTS`` from the configuration file.
+ where 1 <= N <= "number of ports" on the board or ``RTE_MAX_ETHPORTS`` from the configuration file.
The default value is the number of ports on the board.
* ``--coremask=0xXX``
@@ -71,7 +71,7 @@ practical or possible testpmd supports alternative methods for executing command
.. code-block:: console
- ./testpmd -n4 -r2 ... -- -i --cmdline-file=/home/ubuntu/flow-create-commands.txt
+ ./dpdk-testpmd -n4 -r2 ... -- -i --cmdline-file=/home/ubuntu/flow-create-commands.txt
Interactive-mode selected
CLI commands to be read from /home/ubuntu/flow-create-commands.txt
Configuring Port 0 (socket 0)
@@ -329,8 +329,6 @@ The available information categories are:
* ``icmpecho``: Receives a burst of packets, lookup for ICMP echo requests and, if any, send back ICMP echo replies.
-* ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
-
* ``noisy``: Noisy neighbor simulation.
Simulate more realistic behavior of a guest machine engaged in receiving
and sending packets performing Virtual Network Function (VNF).
@@ -379,11 +377,6 @@ Example for the io forwarding engine, with some packet drops on the tx side::
TX-packets: 548595568 TX-dropped: 128 TX-total: 548595696
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-.. note::
-
- Enabling CONFIG_RTE_TEST_PMD_RECORD_CORE_CYCLES appends "CPU cycles/packet" stats, like:
-
- CPU cycles/packet=xx.dd (total cycles=xxxx / total RX packets=xxxx) at xxx MHz clock
clear fwd
~~~~~~~~~