[dpdk-dev] [PATCH v3] doc: use corelist instead of coremask

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Keith Wiles
> Sent: Friday, February 10, 2017 2:01 PM
> To: dev at dpdk.org
> Cc: iryzhov at nfware.com; thomas.monjalon at 6wind.com
> Subject: [dpdk-dev] [PATCH v3] doc: use corelist instead of coremask
> 
> The coremask option in DPDK is difficult to use and we should be
> promoting the use of the corelist (-l) option. The patch
> adjusts the docs to use -l EAL option instead of the -c option.
> 
> The patch only changes the docs and not the code as the -c option
> will continue to exist unless it is removed in the future. The -c
> option should be kept to maintain backward compatibility.

Hi Keith,

Thanks for that. It is a good change and we should make sure that any
new additions to the docs conform to this.

Just to note that the patch no longer applies cleanly and that there
may be some additional "-c" documentation that has been added and some
that has been removed.

Also, a few of the conversation aren't quite right, see below.


> diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst
> index 9a2e973..3762c60 100644
> --- a/doc/guides/nics/mlx4.rst
> +++ b/doc/guides/nics/mlx4.rst
> @@ -343,7 +343,7 @@ devices managed by librte_pmd_mlx4.
>  
>     .. code-block:: console
>  
> -      testpmd -c 0xff00 -n 4 -w 0000:83:00.0 -w 0000:84:00.0 -- --rxq=2 --txq=2 -i
> +      testpmd -l 8-11 -n 4 -w 0000:83:00.0 -w 0000:84:00.0 -- --rxq=2 --txq=2 -i

         testpmd -l 8-15 -n 4 -w 0000:83:00.0 -w 0000:84:00.0 -- --rxq=2 --txq=2 -i

>  
>     Example output:
>  
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
> index 09922a0..5f6e594 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -382,7 +382,7 @@ ConnectX-4/ConnectX-5 devices managed by librte_pmd_mlx5.
>  
>     .. code-block:: console
>  
> -      testpmd -c 0xff00 -n 4 -w 05:00.0 -w 05:00.1 -w 06:00.0 -w 06:00.1 -- --rxq=2 --txq=2 -i
> +      testpmd -l 8-11 -n 4 -w 05:00.0 -w 05:00.1 -w 06:00.0 -w 06:00.1 -- --rxq=2 --txq=2 -i

         testpmd -l 8-15 -n 4 -w 05:00.0 -w 05:00.1 -w 06:00.0 -w 06:00.1 -- --rxq=2 --txq=2 -i


> ... 
> --- a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst
> +++ b/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst
> @@ -365,7 +365,7 @@ Device names and bonding options must be separated by commas as shown below:
>  
>  .. code-block:: console
>  
> -    $RTE_TARGET/app/testpmd -c f -n 4 --vdev 'net_bond0,bond_opt0=..,bond opt1=..'--vdev 'net_bond1,bond _opt0=..,bond_opt1=..'
> +    $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bond0,bond_opt0=..,bond opt1=..'--vdev 'net_bond1,bond _opt0=..,bond_opt1=..'
>  
>  Link Bonding EAL Options
>  ^^^^^^^^^^^^^^^^^^^^^^^^
> @@ -465,22 +465,22 @@ Create a bonded device in round robin mode with two slaves specified by their PC
>  
>  .. code-block:: console
>  
> -    $RTE_TARGET/app/testpmd -c '0xf' -n 4 --vdev 'net_bond0,mode=0, slave=0000:00a:00.01,slave=0000:004:00.00' -- --port-topology=chained
> +    $RTE_TARGET/app/testpmd -l 0-3' -n 4 --vdev 'net_bond0,mode=0, slave=0000:00a:00.01,slave=0000:004:00.00' -- --port-topology=chained

       $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bond0,mode=0, slave=0000:00a:00.01,slave=0000:004:00.00' -- --port-topology=chained

 
> diff --git a/doc/guides/xen/pkt_switch.rst b/doc/guides/xen/pkt_switch.rst
> index 0b4ddfd..717a04b 100644
> --- a/doc/guides/xen/pkt_switch.rst
> +++ b/doc/guides/xen/pkt_switch.rst
> @@ -331,7 +331,7 @@ Building and Running the Switching Backend
>  
> ...
>  .. code-block:: console
>  
> -    ./x86_64-native-linuxapp-gcc/app/testpmd -c f -n 4 --vdev="net_xenvirt0,mac=00:00:00:00:00:22" -- -i --eth-peer=0,00:00:00:00:00:33
> +    ./x86_64-native-linuxapp-gcc/app/testpmd -l 0-7 -n 4 --vdev="net_xenvirt0,mac=00:00:00:00:00:22" -- -i --eth-peer=0,00:00:00:00:00:33
>  

       ./x86_64-native-linuxapp-gcc/app/testpmd -l 0-3 -n 4 --vdev="net_xenvirt0,mac=00:00:00:00:00:22" -- -i --eth-peer=0,00:00:00:00:00:33