[dpdk-dev] [PATCH v2] app/testpmd: unify help strings

Mcnamara, John john.mcnamara at intel.com
Fri Dec 2 11:55:48 CET 2016



> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Ferruh Yigit
> Sent: Friday, December 2, 2016 1:59 AM
> To: dev at dpdk.org
> Cc: De Lara Guarch, Pablo <pablo.de.lara.guarch at intel.com>; Wu, Jingjing
> <jingjing.wu at intel.com>
> Subject: [dpdk-dev] [PATCH v2] app/testpmd: unify help strings
> 
> Formatted as:
> cmd fixed_string fixed|string|options <variable>: Description
> 
> If there is no description, final colon emitted.
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit at intel.com>


Good refactoring work to give consistency. It might be worth having a look at the testpmd docs to see if some of the same improvements can be made there as well. That could be a separate patch.

>  	.f = cmd_config_rss_hash_key_parsed,
>  	.data = NULL,
> -	.help_str =
> -		"port config X rss-hash-key ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|"
> -		"ipv4-sctp|ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|"
> -		"ipv6-sctp|ipv6-other|l2-payload|"
> -		"ipv6-ex|ipv6-tcp-ex|ipv6-udp-ex "
> -		"<string of hexa digits (variable length, NIC dependent)>\n",
> +	.help_str = "port config <port_id> rss-hash-key "
> +		"ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|"
> +		"ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|"
> +		"l2-payload|ipv6-ex|ipv6-tcp-ex|ipv6-udp-ex "
> +		"<string of hexa digits (variable length, NIC dependent)>",

/hex/hexa/

Apart from that:

Acked-by: John McNamara <john.mcnamara at intel.com>



More information about the dev mailing list