diff mbox

[dpdk-dev] app/eventdev: fix typos in timer adapter options

Message ID 20180416100353.28271-1-thomas@monjalon.net (mailing list archive)
State Rejected, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues

Commit Message

Thomas Monjalon April 16, 2018, 10:03 a.m. UTC 
  The options names in code and doc are not the same.

Fixes: 98c6292105d4 ("app/eventdev: add options for event timer adapter")
Cc: pbhagavatula@caviumnetworks.com

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 app/test-eventdev/evt_options.c   |  2 +-
 doc/guides/tools/testeventdev.rst | 12 ++++++------
 2 files changed, 7 insertions(+), 7 deletions(-)

Comments

Pavan Nikhilesh April 16, 2018, 10:07 a.m. UTC | #1 
On Mon, Apr 16, 2018 at 12:03:53PM +0200, Thomas Monjalon wrote:
> The options names in code and doc are not the same.
>
> Fixes: 98c6292105d4 ("app/eventdev: add options for event timer adapter")
> Cc: pbhagavatula@caviumnetworks.com
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  app/test-eventdev/evt_options.c   |  2 +-
>  doc/guides/tools/testeventdev.rst | 12 ++++++------
>  2 files changed, 7 insertions(+), 7 deletions(-)
>
Acked-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
Pavan Nikhilesh April 16, 2018, 10:29 a.m. UTC | #2 
On Mon, Apr 16, 2018 at 12:03:53PM +0200, Thomas Monjalon wrote:
> The options names in code and doc are not the same.
>
> Fixes: 98c6292105d4 ("app/eventdev: add options for event timer adapter")
> Cc: pbhagavatula@caviumnetworks.com
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  app/test-eventdev/evt_options.c   |  2 +-
>  doc/guides/tools/testeventdev.rst | 12 ++++++------
>  2 files changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/app/test-eventdev/evt_options.c b/app/test-eventdev/evt_options.c
> index 5f311a570..701cd4e96 100644
> --- a/app/test-eventdev/evt_options.c
> +++ b/app/test-eventdev/evt_options.c
> @@ -248,7 +248,7 @@ usage(char *program)
>  		"\t                             burst mode.\n"
>  		"\t--nb_timers        : number of timers to arm.\n"
>  		"\t--nb_timer_adptrs  : number of timer adapters to use.\n"
> -		"\t--timer_tick_nsec  : timer tick interval in ns.\n"
> +		"\t--timer_tick_ns    : timer tick interval in ns.\n"
>  		"\t--max_tmo_nsec     : max timeout interval in ns.\n"
>  		"\t--expiry_ns        : event timer expiry ns.\n"
>  		);

I think it would be better to maintain consistency across options, I will send
a patch to fix it.

Thanks,
Pavan
diff mbox

Patch

diff --git a/app/test-eventdev/evt_options.c b/app/test-eventdev/evt_options.c
index 5f311a570..701cd4e96 100644
--- a/app/test-eventdev/evt_options.c
+++ b/app/test-eventdev/evt_options.c
@@ -248,7 +248,7 @@  usage(char *program)
 		"\t                             burst mode.\n"
 		"\t--nb_timers        : number of timers to arm.\n"
 		"\t--nb_timer_adptrs  : number of timer adapters to use.\n"
-		"\t--timer_tick_nsec  : timer tick interval in ns.\n"
+		"\t--timer_tick_ns    : timer tick interval in ns.\n"
 		"\t--max_tmo_nsec     : max timeout interval in ns.\n"
 		"\t--expiry_ns        : event timer expiry ns.\n"
 		);
diff --git a/doc/guides/tools/testeventdev.rst b/doc/guides/tools/testeventdev.rst
index 46effd871..b03c4a17b 100644
--- a/doc/guides/tools/testeventdev.rst
+++ b/doc/guides/tools/testeventdev.rst
@@ -131,7 +131,7 @@  The following are the application command-line options:
 
         Use burst mode event timer adapter as producer.
 
- * ``--timer_tick_nsec``
+ * ``--timer_tick_ns``
 
         Used to dictate number of nano seconds between bucket traversal of the
         event timer adapter. Refer `rte_event_timer_adapter_conf`.
@@ -140,7 +140,7 @@  The following are the application command-line options:
 
         Used to configure event timer adapter max arm timeout in nano seconds.
 
- * ``--expiry_nsec``
+ * ``--expiry_ns``
 
         Dictate the number of nano seconds after which the event timer expires.
 
@@ -379,9 +379,9 @@  Supported application command line options are following::
         --prod_type_ethdev
         --prod_type_timerdev_burst
         --prod_type_timerdev
-        --timer_tick_nsec
+        --timer_tick_ns
         --max_tmo_nsec
-        --expiry_nsec
+        --expiry_ns
         --nb_timers
         --nb_timer_adptrs
 
@@ -478,9 +478,9 @@  Supported application command line options are following::
         --prod_type_ethdev
         --prod_type_timerdev_burst
         --prod_type_timerdev
-        --timer_tick_nsec
+        --timer_tick_ns
         --max_tmo_nsec
-        --expiry_nsec
+        --expiry_ns
         --nb_timers
         --nb_timer_adptrs