Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/138454/?format=api
{ "id": 138454, "url": "https://patches.dpdk.org/api/patches/138454/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20240318111838.16991-7-fengchengwen@huawei.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": "<20240318111838.16991-7-fengchengwen@huawei.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20240318111838.16991-7-fengchengwen@huawei.com", "date": "2024-03-18T11:18:38", "name": "[v4,6/6] argparse: fix doc don't display two hyphens", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "0b9a2b51d5e4d46eb9c41bb0e0643623792c59bc", "submitter": { "id": 2146, "url": "https://patches.dpdk.org/api/people/2146/?format=api", "name": "fengchengwen", "email": "fengchengwen@huawei.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/20240318111838.16991-7-fengchengwen@huawei.com/mbox/", "series": [ { "id": 31544, "url": "https://patches.dpdk.org/api/series/31544/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=31544", "date": "2024-03-18T11:18:32", "name": "refine argparse library", "version": 4, "mbox": "https://patches.dpdk.org/series/31544/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/138454/comments/", "check": "warning", "checks": "https://patches.dpdk.org/api/patches/138454/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 602D043CE3;\n\tMon, 18 Mar 2024 12:21:41 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 3196E40DDD;\n\tMon, 18 Mar 2024 12:21:11 +0100 (CET)", "from szxga04-in.huawei.com (szxga04-in.huawei.com [45.249.212.190])\n by mails.dpdk.org (Postfix) with ESMTP id 4B99D40A6B\n for <dev@dpdk.org>; Mon, 18 Mar 2024 12:21:01 +0100 (CET)", "from mail.maildlp.com (unknown [172.19.162.112])\n by szxga04-in.huawei.com (SkyGuard) with ESMTP id 4TysmN06yDz2BgZL;\n Mon, 18 Mar 2024 19:18:28 +0800 (CST)", "from dggpeml500024.china.huawei.com (unknown [7.185.36.10])\n by mail.maildlp.com (Postfix) with ESMTPS id B08D7140153;\n Mon, 18 Mar 2024 19:20:59 +0800 (CST)", "from localhost.localdomain (10.50.165.33) by\n dggpeml500024.china.huawei.com (7.185.36.10) with Microsoft SMTP Server\n (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id\n 15.1.2507.35; Mon, 18 Mar 2024 19:20:59 +0800" ], "From": "Chengwen Feng <fengchengwen@huawei.com>", "To": "<thomas@monjalon.net>, <david.marchand@redhat.com>", "CC": "<dev@dpdk.org>", "Subject": "[PATCH v4 6/6] argparse: fix doc don't display two hyphens", "Date": "Mon, 18 Mar 2024 11:18:38 +0000", "Message-ID": "<20240318111838.16991-7-fengchengwen@huawei.com>", "X-Mailer": "git-send-email 2.17.1", "In-Reply-To": "<20240318111838.16991-1-fengchengwen@huawei.com>", "References": "<20240220131502.47510-1-fengchengwen@huawei.com>\n <20240318111838.16991-1-fengchengwen@huawei.com>", "MIME-Version": "1.0", "Content-Type": "text/plain", "X-Originating-IP": "[10.50.165.33]", "X-ClientProxiedBy": "dggems704-chm.china.huawei.com (10.3.19.181) To\n dggpeml500024.china.huawei.com (7.185.36.10)", "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": "With the line in rst file:\n\tThe single mode: \"--aaa\" or \"-a\".\ncorresponding line in html doc:\n\tThe single mode: -aaa or -a.\nthe two hyphens (--aaa) become one (-aaa).\n\nAccording to [1], this commit uses the backquote (``xxx``) to fix it.\nAnd for consistency, use this format for all arguments.\n\nFixes: e3e579f5bab5 (\"argparse: introduce argparse library\")\n\n[1] https://stackoverflow.com/questions/51075907/display-two-dashes-in-rst-file\n\nSigned-off-by: Chengwen Feng <fengchengwen@huawei.com>\n---\n doc/guides/prog_guide/argparse_lib.rst | 47 +++++++++++++-------------\n lib/argparse/rte_argparse.h | 4 +--\n 2 files changed, 26 insertions(+), 25 deletions(-)", "diff": "diff --git a/doc/guides/prog_guide/argparse_lib.rst b/doc/guides/prog_guide/argparse_lib.rst\nindex a6ac11b1c0..f827312daa 100644\n--- a/doc/guides/prog_guide/argparse_lib.rst\n+++ b/doc/guides/prog_guide/argparse_lib.rst\n@@ -90,9 +90,9 @@ The following code demonstrates how to use:\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+arguments (they're ``--aaa``/``--bbb``/``--ccc``/``--ddd``/``--eee``/``--fff``);\n+and the arguments which don't start with a hyphen (-) are positional arguments\n+(they're ``ooo``/``ppp``).\n \n Every argument must be set whether to carry a value (one of\n ``RTE_ARGPARSE_ARG_NO_VALUE``, ``RTE_ARGPARSE_ARG_REQUIRED_VALUE`` and\n@@ -106,23 +106,23 @@ User Input Requirements\n ~~~~~~~~~~~~~~~~~~~~~~~\n \n For optional arguments which take no-value,\n-the following mode is supported (take above \"--aaa\" as an example):\n+the following mode is supported (take above ``--aaa`` as an example):\n \n-- The single mode: \"--aaa\" or \"-a\".\n+- The single mode: ``--aaa`` or ``-a``.\n \n For optional arguments which take required-value,\n-the following two modes are supported (take above \"--bbb\" as an example):\n+the following two modes are supported (take above ``--bbb`` as an example):\n \n-- The kv mode: \"--bbb=1234\" or \"-b=1234\".\n+- The kv mode: ``--bbb=1234`` or ``-b=1234``.\n \n-- The split mode: \"--bbb 1234\" or \"-b 1234\".\n+- The split mode: ``--bbb 1234`` or ``-b 1234``.\n \n For optional arguments which take optional-value,\n-the following two modes are supported (take above \"--ccc\" as an example):\n+the following two modes are supported (take above ``--ccc`` as an example):\n \n-- The single mode: \"--ccc\" or \"-c\".\n+- The single mode: ``--ccc`` or ``-c``.\n \n-- The kv mode: \"--ccc=123\" or \"-c=123\".\n+- The kv mode: ``--ccc=123`` or ``-c=123``.\n \n For positional arguments which must take required-value,\n their values are parsing in the order defined.\n@@ -130,7 +130,7 @@ their values are parsing in the order defined.\n .. note::\n \n The compact mode is not supported.\n- Take above \"-a\" and \"-d\" as an example, don't support \"-ad\" input.\n+ Take above ``-a`` and ``-d`` as an example, don't support ``-ad`` input.\n \n Parsing by autosave way\n ~~~~~~~~~~~~~~~~~~~~~~~\n@@ -139,23 +139,23 @@ 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 \n-In the above example, the arguments \"--aaa\"/\"--bbb\"/\"--ccc\" and \"ooo\"\n+In the above example, the arguments ``--aaa``/``--bbb``/``--ccc`` and ``ooo``\n both use this way, the parsing is as follows:\n \n-- For argument \"--aaa\", it is configured as no-value,\n+- For argument ``--aaa``, it is configured as no-value,\n so the ``aaa_val`` will be set to ``val_set`` field\n which is 100 in the above example.\n \n-- For argument \"--bbb\", it is configured as required-value,\n+- For argument ``--bbb``, it is configured as required-value,\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+ (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- which is 200 in the above example;\n- if user input \"--ccc=123\", then the ``ccc_val`` will be set to 123.\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``\n+ field which is 200 in the above example;\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+- 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@@ -165,7 +165,8 @@ 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 \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``\n+both use this way.\n \n Multiple times argument\n ~~~~~~~~~~~~~~~~~~~~~~~\n@@ -178,7 +179,7 @@ For example:\n \n { \"--xyz\", \"-x\", \"xyz argument\", NULL, (void *)10, RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_SUPPORT_MULTI },\n \n-Then the user input could contain multiple \"--xyz\" arguments.\n+Then the user input could contain multiple ``--xyz`` arguments.\n \n .. note::\n \ndiff --git a/lib/argparse/rte_argparse.h b/lib/argparse/rte_argparse.h\nindex 98ad9971ea..b6b016e388 100644\n--- a/lib/argparse/rte_argparse.h\n+++ b/lib/argparse/rte_argparse.h\n@@ -83,8 +83,8 @@ extern \"C\" {\n struct rte_argparse_arg {\n \t/**\n \t * Long name of the argument:\n-\t * 1) If the argument is optional, it must start with '--'.\n-\t * 2) If the argument is positional, it must not start with '-'.\n+\t * 1) If the argument is optional, it must start with ``--``.\n+\t * 2) If the argument is positional, it must not start with ``-``.\n \t * 3) Other case will be considered as error.\n \t */\n \tconst char *name_long;\n", "prefixes": [ "v4", "6/6" ] }