Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/140032/?format=api
{ "id": 140032, "url": "https://patches.dpdk.org/api/patches/140032/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20240513155911.31872-4-nandinipersad361@gmail.com/", "project": { "id": 1, "url": "https://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20240513155911.31872-4-nandinipersad361@gmail.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20240513155911.31872-4-nandinipersad361@gmail.com", "date": "2024-05-13T15:59:05", "name": "[3/9] doc: reword argparse section in prog guide", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "ec300c0a0190c301ed0ec05d6b54031851178658", "submitter": { "id": 3325, "url": "https://patches.dpdk.org/api/people/3325/?format=api", "name": "Nandini Persad", "email": "nandinipersad361@gmail.com" }, "delegate": { "id": 1, "url": "https://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20240513155911.31872-4-nandinipersad361@gmail.com/mbox/", "series": [ { "id": 31913, "url": "https://patches.dpdk.org/api/series/31913/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=31913", "date": "2024-05-13T15:59:02", "name": "reowrd in prog guide", "version": 1, "mbox": "https://patches.dpdk.org/series/31913/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/140032/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/140032/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 236A84401C;\n\tMon, 13 May 2024 18:01:56 +0200 (CEST)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id C209740A6F;\n\tMon, 13 May 2024 18:01:39 +0200 (CEST)", "from mail-pf1-f177.google.com (mail-pf1-f177.google.com\n [209.85.210.177])\n by mails.dpdk.org (Postfix) with ESMTP id 2E9FC4068A\n for <dev@dpdk.org>; Mon, 13 May 2024 17:59:34 +0200 (CEST)", "by mail-pf1-f177.google.com with SMTP id\n d2e1a72fcca58-6f44b390d5fso3875009b3a.3\n for <dev@dpdk.org>; Mon, 13 May 2024 08:59:34 -0700 (PDT)", "from localhost.localdomain (syn-076-032-089-124.res.spectrum.com.\n [76.32.89.124]) by smtp.gmail.com with ESMTPSA id\n d2e1a72fcca58-6f4d2aa16dfsm7715078b3a.93.2024.05.13.08.59.32\n for <dev@dpdk.org>\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Mon, 13 May 2024 08:59:32 -0700 (PDT)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=gmail.com; s=20230601; t=1715615973; x=1716220773; darn=dpdk.org;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:to:from:from:to:cc:subject:date:message-id\n :reply-to; bh=52vRRnKzaU4qoo4ra4R6E1KzbeNonGh6OU//roUYvcQ=;\n b=KmNyVDVGtrp9gCWsjQ1UcV04LN79p2ac5x23g43nDvchsXa0AplNRlPcgg3Wz+YiHl\n 5BlUSvkswH0p5/LhgJ/oNvqhw1AYuJbj81pfRA5kDU0BrK8jrs+2MR46tQjGhd9g58j0\n IG/6qoGE+17DUjrmRqP8fP/4TQKuKIwvWQAWaJlL+IVQB6WGpiV7482WX9y+ojIfuh79\n 6ozdcKONLwFxKBxpPCJIMGxl+tn5fzPJ1nZ6uFIuAq/n2z/CUfZKKVref5Qenb0Z5vqA\n 7uH8oSaBfPPgqi/3mbXgwslGWyQ+vC6/99exv+R8s3o0vTd7PMiOWaBKF+UWUWlHfR+Z\n 8e6Q==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1715615973; x=1716220773;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:to:from:x-gm-message-state:from:to:cc\n :subject:date:message-id:reply-to;\n bh=52vRRnKzaU4qoo4ra4R6E1KzbeNonGh6OU//roUYvcQ=;\n b=b7/4CW6Ihno4WBiVuLennvwmISUm9j1PZvQg8OYMgHNy7TnNO5XlGZi79eBkZDwuJq\n L95A4BG5pXoNIkFi75saY9tzXD2kNPaXXv/TOqGwizaVBHRHfiNkl6rPlTRDgsYcWv3D\n z/B5YoXWB+WziLAGbNnjJQWuVFeFihIZZQgtYqBVqEYKl3Ipvy0wb5vvVBc+D3BP50uc\n gEmPBIKwHEdR5WAnG8OnLdfF7vBGpYhnxAb5hvInN1u+suSrG8qxbrO8YabcJhBYUBo6\n /DPTkttype8qB4HD8ER5s1dvRLd3T078CJzfEdR/FzjSCSXZZTV3eJUgnvrFNnJGVv9D\n mW0w==", "X-Gm-Message-State": "AOJu0Ywg45xP5zThDIa9PDpgsskLetm4XTx2skgXHcDhScY3EVSYcHTf\n PL4agLWU0xnAOcdv+CQxoyJXBdiEisp12Z5DW7jG1nBJmqj1DzLQUdiXOw==", "X-Google-Smtp-Source": "\n AGHT+IEHGQeBqFLdyHY5IlB3UJdiT+LPABFyMtP9dMvAjfQIW8WFTt9xIJRvELanwQcF2ue6CJ3cUQ==", "X-Received": "by 2002:a05:6a00:10c9:b0:6f3:f447:5861 with SMTP id\n d2e1a72fcca58-6f4e026b8f2mr11793875b3a.5.1715615972876;\n Mon, 13 May 2024 08:59:32 -0700 (PDT)", "From": "Nandini Persad <nandinipersad361@gmail.com>", "To": "dev@dpdk.org", "Subject": "[PATCH 3/9] doc: reword argparse section in prog guide", "Date": "Mon, 13 May 2024 08:59:05 -0700", "Message-Id": "<20240513155911.31872-4-nandinipersad361@gmail.com>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20240513155911.31872-1-nandinipersad361@gmail.com>", "References": "<20240513155911.31872-1-nandinipersad361@gmail.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "X-Mailman-Approved-At": "Mon, 13 May 2024 18:01:34 +0200", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "made small edits to sections 6.1 and 6.2 intro\n\nSigned-off-by: Nandini Persad <nandinipersad361@gmail.com>\n---\n doc/guides/prog_guide/argparse_lib.rst | 72 +++++++++++++-------------\n 1 file changed, 35 insertions(+), 37 deletions(-)", "diff": "diff --git a/doc/guides/prog_guide/argparse_lib.rst b/doc/guides/prog_guide/argparse_lib.rst\nindex a6ac11b1c0..a2af7d49e9 100644\n--- a/doc/guides/prog_guide/argparse_lib.rst\n+++ b/doc/guides/prog_guide/argparse_lib.rst\n@@ -4,22 +4,21 @@\n Argparse Library\n ================\n \n-The argparse library provides argument parsing functionality,\n-this library makes it easy to write user-friendly command-line program.\n+The argparse library provides argument parsing functionality and makes it easy to write user-friendly command-line programming.\n \n Features and Capabilities\n -------------------------\n \n-- Support parsing optional argument (which could take with no-value,\n- required-value and optional-value).\n+- Supports parsing of optional arguments (which can contain no-value,\n+ required-value and optional-values).\n \n-- Support parsing positional argument (which must take with required-value).\n+- Supports parsing of positional arguments (which must contain required-values).\n \n-- Support automatic generate usage information.\n+- Supports automatic generation of usage information.\n \n-- Support issue errors when provide with invalid arguments.\n+- Provides issue errors when an argument is invalid\n \n-- Support parsing argument by two ways:\n+- Supports parsing arguments in two ways:\n \n #. autosave: used for parsing known value types;\n #. callback: will invoke user callback to parse.\n@@ -27,7 +26,7 @@ Features and Capabilities\n Usage Guide\n -----------\n \n-The following code demonstrates how to use:\n+The following code demonstrates how to use the following:\n \n .. code-block:: C\n \n@@ -89,12 +88,12 @@ The following code demonstrates how to use:\n ...\n }\n \n-In this example, the arguments which start with a hyphen (-) are optional\n-arguments (they're \"--aaa\"/\"--bbb\"/\"--ccc\"/\"--ddd\"/\"--eee\"/\"--fff\"); and the\n-arguments which don't start with a hyphen (-) are positional arguments\n-(they're \"ooo\"/\"ppp\").\n+In this example, the arguments thhat start with a hyphen (-) are optional\n+arguments (\"--aaa\"/\"--bbb\"/\"--ccc\"/\"--ddd\"/\"--eee\"/\"--fff\").\n+The arguments that do not start with a hyphen (-) are positional arguments\n+(\"ooo\"/\"ppp\").\n \n-Every argument must be set whether to carry a value (one of\n+Every argument must set whether it carries a value (one of\n ``RTE_ARGPARSE_ARG_NO_VALUE``, ``RTE_ARGPARSE_ARG_REQUIRED_VALUE`` and\n ``RTE_ARGPARSE_ARG_OPTIONAL_VALUE``).\n \n@@ -105,26 +104,26 @@ Every argument must be set whether to carry a value (one of\n User Input Requirements\n ~~~~~~~~~~~~~~~~~~~~~~~\n \n-For optional arguments which take no-value,\n+For optional arguments which have no-value,\n the following mode is supported (take above \"--aaa\" as an example):\n \n - The single mode: \"--aaa\" or \"-a\".\n \n-For optional arguments which take required-value,\n+For optional arguments which have required-value,\n the following two modes are supported (take above \"--bbb\" as an example):\n \n - The kv mode: \"--bbb=1234\" or \"-b=1234\".\n \n - The split mode: \"--bbb 1234\" or \"-b 1234\".\n \n-For optional arguments which take optional-value,\n+For optional arguments which have optional-value,\n the following two modes are supported (take above \"--ccc\" as an example):\n \n - The single mode: \"--ccc\" or \"-c\".\n \n - The kv mode: \"--ccc=123\" or \"-c=123\".\n \n-For positional arguments which must take required-value,\n+For positional arguments which must have required-value,\n their values are parsing in the order defined.\n \n .. note::\n@@ -132,15 +131,15 @@ their values are parsing in the order defined.\n The compact mode is not supported.\n Take above \"-a\" and \"-d\" as an example, don't support \"-ad\" input.\n \n-Parsing by autosave way\n+Parsing the Autosave Method\n ~~~~~~~~~~~~~~~~~~~~~~~\n \n-Argument of known value type (e.g. ``RTE_ARGPARSE_ARG_VALUE_INT``)\n-could be parsed using this autosave way,\n-and its result will save in the ``val_saver`` field.\n+Arguments of a known value type (e.g. ``RTE_ARGPARSE_ARG_VALUE_INT``)\n+can be parsed using the autosave method,\n+The result will save in the ``val_saver`` field.\n \n In the above example, the arguments \"--aaa\"/\"--bbb\"/\"--ccc\" and \"ooo\"\n-both use this way, the parsing is as follows:\n+both use this method. The parsing is as follows:\n \n - For argument \"--aaa\", it is configured as no-value,\n so the ``aaa_val`` will be set to ``val_set`` field\n@@ -150,28 +149,27 @@ both use this way, the parsing is as follows:\n so the ``bbb_val`` will be set to user input's value\n (e.g. will be set to 1234 with input \"--bbb 1234\").\n \n-- For argument \"--ccc\", it is configured as optional-value,\n- if user only input \"--ccc\" then the ``ccc_val`` will be set to ``val_set`` field\n+- For argument \"--ccc\", it is configured as optional-value.\n+ If user only input \"--ccc\", then the ``ccc_val`` will be set to ``val_set`` field\n which is 200 in the above example;\n- if user input \"--ccc=123\", then the ``ccc_val`` will be set to 123.\n+ If user input \"--ccc=123\", then the ``ccc_val`` will be set to 123.\n \n - For argument \"ooo\", it is positional argument,\n the ``ooo_val`` will be set to user input's value.\n \n-Parsing by callback way\n-~~~~~~~~~~~~~~~~~~~~~~~\n-\n-It could also choose to use callback to parse,\n-just define a unique index for the argument\n-and make the ``val_save`` field to be NULL also zero value-type.\n+Parsing by Callback Method\n+~~~~~~~~~\n+You may choose to use the callback method to parse.\n+To do so, define a unique index for the argument\n+and make the ``val_save`` field to be NULL as a zero value-type.\n \n-In the above example, the arguments \"--ddd\"/\"--eee\"/\"--fff\" and \"ppp\" both use this way.\n+In the above example, the arguments \"--ddd\"/\"--eee\"/\"--fff\" and \"ppp\" both use this method.\n \n-Multiple times argument\n+Multiple Times Argument\n ~~~~~~~~~~~~~~~~~~~~~~~\n \n-If want to support the ability to enter the same argument multiple times,\n-then should mark ``RTE_ARGPARSE_ARG_SUPPORT_MULTI`` in the ``flags`` field.\n+If you want to support the ability to enter the same argument multiple times,\n+then you should mark ``RTE_ARGPARSE_ARG_SUPPORT_MULTI`` in the ``flags`` field.\n For example:\n \n .. code-block:: C\n@@ -182,5 +180,5 @@ Then the user input could contain multiple \"--xyz\" arguments.\n \n .. note::\n \n- The multiple times argument only support with optional argument\n+ The multiple times argument is only supported with optional argument\n and must be parsed by callback way.\n", "prefixes": [ "3/9" ] }