DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: david.marchand@redhat.com,
	Bruce Richardson <bruce.richardson@intel.com>,
	Chengwen Feng <fengchengwen@huawei.com>
Subject: [PATCH v7 04/13] argparse: add documentation on supported value types
Date: Wed, 23 Jul 2025 17:20:02 +0100	[thread overview]
Message-ID: <20250723162013.2392-5-bruce.richardson@intel.com> (raw)
In-Reply-To: <20250723162013.2392-1-bruce.richardson@intel.com>

The different value types supported by the argparse library are not
discussed in the documentation, so add some reference material about
them.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/prog_guide/argparse_lib.rst | 73 +++++++++++++++++++++++++-
 1 file changed, 71 insertions(+), 2 deletions(-)

diff --git a/doc/guides/prog_guide/argparse_lib.rst b/doc/guides/prog_guide/argparse_lib.rst
index b309260d20..7868af5672 100644
--- a/doc/guides/prog_guide/argparse_lib.rst
+++ b/doc/guides/prog_guide/argparse_lib.rst
@@ -160,6 +160,75 @@ both use this way, the parsing is as follows:
 - For argument ``ooo``, it is positional argument,
   the ``ooo_val`` will be set to user input's value.
 
+Supported Value Types
+~~~~~~~~~~~~~~~~~~~~~
+
+The argparse library supports automatic parsing of several data types when using
+the autosave method. The parsed values are automatically converted from string
+input to the appropriate data type and stored in the ``val_saver`` field.
+
+Integer Types
+^^^^^^^^^^^^^
+
+The library supports parsing various integer types:
+
+- ``RTE_ARGPARSE_VALUE_TYPE_INT`` - signed integer
+- ``RTE_ARGPARSE_VALUE_TYPE_U8`` - unsigned 8-bit integer
+- ``RTE_ARGPARSE_VALUE_TYPE_U16`` - unsigned 16-bit integer
+- ``RTE_ARGPARSE_VALUE_TYPE_U32`` - unsigned 32-bit integer
+- ``RTE_ARGPARSE_VALUE_TYPE_U64`` - unsigned 64-bit integer
+
+.. code-block:: C
+
+   static int my_int;
+   static uint16_t my_port;
+   static uint32_t my_count;
+
+   static struct rte_argparse obj = {
+      .args = {
+         { "--number", "-n", "Integer value", &my_int, NULL, RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_INT },
+         { "--port", "-p", "Port number", &my_port, NULL, RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U16 },
+         { "--count", "-c", "Count value", &my_count, (void *)1000, RTE_ARGPARSE_VALUE_OPTIONAL, RTE_ARGPARSE_VALUE_TYPE_U32 },
+         ARGPARSE_ARG_END(),
+      },
+   };
+
+String Type
+^^^^^^^^^^^
+
+String arguments are parsed using ``RTE_ARGPARSE_VALUE_TYPE_STR``.
+When using this type, the input value is saved to the provided pointer without any parsing or validation.
+
+.. code-block:: C
+
+   static const char *my_string;
+
+   static struct rte_argparse obj = {
+      .args = {
+         { "--name", "-n", "Name string", &my_string, NULL, RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_STR },
+         ARGPARSE_ARG_END(),
+      },
+   };
+
+Boolean Type
+^^^^^^^^^^^^
+
+Boolean arguments are parsed using ``RTE_ARGPARSE_VALUE_TYPE_BOOL`` and accept the following input formats:
+
+- ``true``, ``false`` (case-sensitive)
+- ``1``, ``0`` (numeric format)
+
+.. code-block:: C
+
+   static bool my_flag;
+
+   static struct rte_argparse obj = {
+      .args = {
+         { "--enable", "-e", "Enable feature", &my_flag, NULL, RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_BOOL },
+         ARGPARSE_ARG_END(),
+      },
+   };
+
 Parsing by callback way
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -167,8 +236,8 @@ It could also choose to use callback to parse,
 just define a unique index for the argument
 and make the ``val_save`` field to be NULL also zero value-type.
 
-In the above example, the arguments ``--ddd``/``--eee``/``--fff`` and ``ppp``
-both use this way.
+In the example at the top of this section,
+the arguments ``--ddd``/``--eee``/``--fff`` and ``ppp`` all use this way.
 
 Multiple times argument
 ~~~~~~~~~~~~~~~~~~~~~~~
-- 
2.48.1


  parent reply	other threads:[~2025-07-23 16:21 UTC|newest]

Thread overview: 81+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-20 16:40 [RFC PATCH 0/7] rework EAL argument parsing in DPDK Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 1/7] eal: add long options for each short option Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 2/7] argparse: add support for string and boolean args Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 3/7] argparse: make argparse EAL-args compatible Bruce Richardson
2025-05-22 10:44   ` Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 4/7] eal: define the EAL parameters in argparse format Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 5/7] eal: gather EAL args before processing Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 6/7] eal: combine parameter validation checks Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 7/7] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-07-08 17:20 ` [RFC PATCH v2 0/5] rework EAL argument parsing in DPDK Bruce Richardson
2025-07-08 17:20   ` [RFC PATCH v2 1/5] eal: add long options for each short option Bruce Richardson
2025-07-08 17:20   ` [RFC PATCH v2 2/5] eal: define the EAL parameters in argparse format Bruce Richardson
2025-07-08 17:20   ` [RFC PATCH v2 3/5] eal: gather EAL args before processing Bruce Richardson
2025-07-08 17:20   ` [RFC PATCH v2 4/5] eal: combine parameter validation checks Bruce Richardson
2025-07-08 17:20   ` [RFC PATCH v2 5/5] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-07-08 18:41   ` [RFC PATCH v2 0/5] rework EAL argument parsing in DPDK Stephen Hemminger
2025-07-09  7:50     ` Bruce Richardson
2025-07-09 12:30   ` David Marchand
2025-07-09 12:54     ` Bruce Richardson
2025-07-17 10:41   ` David Marchand
2025-07-17 10:54     ` Bruce Richardson
2025-07-18 14:33 ` [PATCH v3 0/9] rework EAL argument parsing Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 1/9] build: add define for the OS environment name Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 2/9] argparse: export function to print help text for object Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 3/9] argparse: allow user-override of help printing Bruce Richardson
2025-07-21  8:43     ` David Marchand
2025-07-21  9:00       ` Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 4/9] eal: add long options for each short option Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 5/9] eal: define the EAL parameters in argparse format Bruce Richardson
2025-07-21  8:41     ` David Marchand
2025-07-21  9:05       ` Bruce Richardson
2025-07-21 12:53         ` Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 6/9] eal: gather EAL args before processing Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 7/9] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 8/9] eal: combine parameter validation checks Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 9/9] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-07-18 14:41   ` [PATCH v3 0/9] rework EAL argument parsing Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 " Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 1/9] build: add define for the OS environment name Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 2/9] argparse: export function to print help text for object Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 3/9] argparse: allow user-override of help printing Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 4/9] eal: add long options for each short option Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 5/9] eal: define the EAL parameters in argparse format Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 6/9] eal: gather EAL args before processing Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 7/9] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 8/9] eal: combine parameter validation checks Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 9/9] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-07-21 15:16 ` [PATCH v5 0/9] rework EAL argument parsing Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 1/9] build: add define for the OS environment name Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 2/9] argparse: export function to print help text for object Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 3/9] argparse: allow user-override of help printing Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 4/9] eal: add long options for each short option Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 5/9] eal: define the EAL parameters in argparse format Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 6/9] eal: gather EAL args before processing Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 7/9] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 8/9] eal: combine parameter validation checks Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 9/9] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-07-22 14:03 ` [PATCH v6 0/9] rework EAL argument parsing Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 1/9] build: add define for the OS environment name Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 2/9] argparse: export function to print help text for object Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 3/9] argparse: allow user-override of help printing Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 4/9] eal: add long options for each short option Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 5/9] eal: define the EAL parameters in argparse format Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 6/9] eal: gather EAL args before processing Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 7/9] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 8/9] eal: combine parameter validation checks Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 9/9] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-07-23 16:19 ` [PATCH v7 00/13] Simplify running with high-numbered CPUs Bruce Richardson
2025-07-23 16:19   ` [PATCH v7 01/13] build: add define for the OS environment name Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 02/13] argparse: export function to print help text for object Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 03/13] argparse: allow user-override of help printing Bruce Richardson
2025-07-23 16:20   ` Bruce Richardson [this message]
2025-07-23 16:20   ` [PATCH v7 05/13] eal: add long options for each short option Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 06/13] eal: define the EAL parameters in argparse format Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 07/13] eal: gather EAL args before processing Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 08/13] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 09/13] eal: combine parameter validation checks Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 10/13] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 11/13] argparse: add support for parsing core lists Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 12/13] eal: simplify running CPUs with ids above max lcores Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 13/13] eal: add warnings about ignored options Bruce Richardson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250723162013.2392-5-bruce.richardson@intel.com \
    --to=bruce.richardson@intel.com \
    --cc=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    --cc=fengchengwen@huawei.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).