From mboxrd@z Thu Jan  1 00:00:00 1970
From: Jens Freimann <jfreimann@redhat.com>
Subject: Re: [PATCH v2 2/2] testpmd: update testpmd documentation
 to include noisy forwarding mode
Date: Mon, 16 Apr 2018 22:17:15 +0200
Message-ID: <20180416201715.j7ucv4yc7ekrumv5@localhost.localdomain>
References: <20180413113716.27968-1-jfreimann@redhat.com>
 <20180413113716.27968-3-jfreimann@redhat.com>
 <40abbbc6-911f-163c-a18f-2433e4cee48c@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii; format=flowed
Cc: dev@dpdk.org, ailan@redhat.com, jan.scheurich@ericsson.com,
 vkaplans@redhat.com, bruce.richardson@intel.com,
 thomas@monjalon.net, maxime.coquelin@redhat.com,
 konstantin.ananyev@intel.com
To: Ferruh Yigit <ferruh.yigit@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mx1.redhat.com (mx3-rdu2.redhat.com [66.187.233.73])
 by dpdk.org (Postfix) with ESMTP id 1CD71AAB7
 for <dev@dpdk.org>; Mon, 16 Apr 2018 22:17:19 +0200 (CEST)
Content-Disposition: inline
In-Reply-To: <40abbbc6-911f-163c-a18f-2433e4cee48c@intel.com>
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

On Fri, Apr 13, 2018 at 02:19:28PM +0100, Ferruh Yigit wrote:
>On 4/13/2018 12:37 PM, Jens Freimann wrote:
>> Signed-off-by: Jens Freimann <jfreimann@redhat.com>
>> ---
>>  doc/guides/testpmd_app_ug/run_app.rst       | 27 +++++++++++++++++++++++++++
>>  doc/guides/testpmd_app_ug/testpmd_funcs.rst |  7 +++++--
>>  2 files changed, 32 insertions(+), 2 deletions(-)
>>
>> diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
>> index 1fd53958a..0b7046bb0 100644
>> --- a/doc/guides/testpmd_app_ug/run_app.rst
>> +++ b/doc/guides/testpmd_app_ug/run_app.rst
>> @@ -340,6 +340,7 @@ The commandline options are:
>>         icmpecho
>>         ieee1588
>>         tm
>> +       noisy
>>
>>  *   ``--rss-ip``
>>
>> @@ -479,3 +480,29 @@ The commandline options are:
>>
>>      Set the hexadecimal bitmask of TX queue offloads.
>>      The default value is 0.
>> +
>> +*   ``--buffersize-before-sending=N``
>> +
>> +    Set the number of maximum elements  of the FIFO queue to be created
>> +    for buffering packets. Only available with the noisy forwarding mode.
>> +    The default value is 0.
>> +
>> +*   ``--flush-timeout=N``
>> +
>> +    Set the size of the FIFO queue to be created for buffering packets.
>> +    Only available with the noisy forwarding mode. The default value is 0.
>
>Some of the there parameter names are so generic when you think them in the
>scope of the whole testpmd it can be confusing and hard to understand what they
>are for.
>
>What do you think adding a prefix to all noisy neighbor related commands?

Yes, I think it is  a good point. Thanks for the review!

regards,
Jens 

>
>> +
>> +*   ``--nb-rnd-read=N``
>> +
>> +    Set the number of reads to be done in noisy neighbour simulation memory buffer.
>> +    Only available with the noisy forwarding mode. The default value is 0.
>> +
>> +*   ``--nb-rnd-write=N``
>> +
>> +    Set the number of writes to be done in noisy neighbour simulation memory buffer.
>> +    Only available with the noisy forwarding mode. The default value is 0.
>> +
>> +*   ``--nb-rnd-write=N``
>> +
>> +    Set the number of r/w access to be done in noisy neighbour simulation memory buffer.
>> +    Only available with the noisy forwarding mode. The default value is 0.
>
><...>