Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/140036/?format=api
{ "id": 140036, "url": "https://patches.dpdk.org/api/patches/140036/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20240513155911.31872-8-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-8-nandinipersad361@gmail.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20240513155911.31872-8-nandinipersad361@gmail.com", "date": "2024-05-13T15:59:09", "name": "[7/9] doc: reword cmdline section in prog guide", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "2e992d36f3ff7eec3f009897cb14747e56afb5d4", "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-8-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/140036/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/140036/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 BF4B64401C;\n\tMon, 13 May 2024 18:02:28 +0200 (CEST)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id B9C0840DCD;\n\tMon, 13 May 2024 18:01:44 +0200 (CEST)", "from mail-pf1-f179.google.com (mail-pf1-f179.google.com\n [209.85.210.179])\n by mails.dpdk.org (Postfix) with ESMTP id 4E6FF4068E\n for <dev@dpdk.org>; Mon, 13 May 2024 17:59:47 +0200 (CEST)", "by mail-pf1-f179.google.com with SMTP id\n d2e1a72fcca58-6f44bcbaae7so4065639b3a.2\n for <dev@dpdk.org>; Mon, 13 May 2024 08:59:47 -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.45\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:45 -0700 (PDT)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=gmail.com; s=20230601; t=1715615986; x=1716220786; 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=fjmTry2NeZgJJ1Rj4aw47Bopi2Et1pkxZannefL0ELM=;\n b=fFZKhOR2pY/ypfAzx/Ey29KEnNRl8UP178OSEPfY00rz5NGZat6JQzGc1bpgdlgH/N\n +EZWyN13lJzLoKgFDs9FGE72qvQAE3hfy3AR2aD2Sl6DwMm+X0KLqwAlKF7J0QuswVtM\n GaViu/beV+No3OC3Ar2i4qsLyh5bEkgBK+fdp6FlyO0bSzD7WcvRGtrHbh2TQEP77MBB\n a5Jn9fGHu/k/vI//Gigf564oVUycShNkmgqDsUgr0pMPk43o64vvNzEtNef7lXImh6S9\n Z37gWRKqTq2FA/yU9G5kbgFLiGhN3MkfsmJ/4aoFGA3GX5iWB44RGRMIqbDTxoWF1rzT\n VIdw==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1715615986; x=1716220786;\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=fjmTry2NeZgJJ1Rj4aw47Bopi2Et1pkxZannefL0ELM=;\n b=fmug2KCfm3PAczcZdSy0jV1293WrMpkSH+kZavh9hTcbc26cmFH6FLHIsKBpKDGLXv\n KpxLBTYQMK2yyiUowEc8gkPQQBT4Gi1KuykayNDLmr9J1lhRCrcJB9cPRVafTYx91n7h\n FCHvn7wz5q6p+Qd5EcRlPkuth0ZtK2TIEn2c1WNkxmBy8NzHSoSpUFCrg5q58IpkPsHa\n DUqRWEIN/gVj7H7I/0AdWd4ujYj8Mn2VTlJ0LiMH7qkANp3IVm7D5w0oB3HzCIK0cqOW\n ua4UTupoa/dqSBW4H20iJEm9bjLqvOJTlWUfxZ1mYrluC9K5ougKGbOVp74mdAQR9AZN\n 05wA==", "X-Gm-Message-State": "AOJu0YyEdxC8HY4w0IqpR7VdceJbjlwMxtIw7Unu6V0hCOCzNtySIMxF\n clNmK1NFFMEp4zE72KUmUcJ7KqhIwCsRQnwcLEjoONCGpCB4aX8V/CFYFA==", "X-Google-Smtp-Source": "\n AGHT+IGpDnxIZwhhXWQi6B+rkHuh8k3c6iZNy3iSWOwN8En6O9ukyolqEYw/5Zj1XUs280H11Hyfhg==", "X-Received": "by 2002:a05:6a00:3a0b:b0:6ec:f2e7:21a8 with SMTP id\n d2e1a72fcca58-6f4e0346677mr10957713b3a.21.1715615986069;\n Mon, 13 May 2024 08:59:46 -0700 (PDT)", "From": "Nandini Persad <nandinipersad361@gmail.com>", "To": "dev@dpdk.org", "Subject": "[PATCH 7/9] doc: reword cmdline section in prog guide", "Date": "Mon, 13 May 2024 08:59:09 -0700", "Message-Id": "<20240513155911.31872-8-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": "minor syntax edits\n\nSigned-off-by: Nandini Persad <nandinipersad361@gmail.com>\n---\n doc/guides/prog_guide/cmdline.rst | 34 +++++++++++++++----------------\n 1 file changed, 17 insertions(+), 17 deletions(-)", "diff": "diff --git a/doc/guides/prog_guide/cmdline.rst b/doc/guides/prog_guide/cmdline.rst\nindex 6b10ab6c99..8aa1ef180b 100644\n--- a/doc/guides/prog_guide/cmdline.rst\n+++ b/doc/guides/prog_guide/cmdline.rst\n@@ -62,7 +62,7 @@ The format of the list file must follow these requirements:\n \n * One command per line\n \n-* Variable fields are prefixed by the type-name in angle-brackets, for example:\n+* Variable fields are prefixed by the type-name in angle-brackets. For example:\n \n * ``<STRING>message``\n \n@@ -75,7 +75,7 @@ The format of the list file must follow these requirements:\n * ``<IPv6>dst_ip6``\n \n * Variable fields, which take their values from a list of options,\n- have the comma-separated option list placed in braces, rather than by the type name.\n+ have the comma-separated option list placed in braces rather than by the type name.\n For example,\n \n * ``<(rx,tx,rxtx)>mode``\n@@ -112,7 +112,7 @@ The generated content includes:\n \n * A command-line context array definition, suitable for passing to ``cmdline_new``\n \n-If so desired, the script can also output function stubs for the callback functions for each command.\n+If needed, the script can also output function stubs for the callback functions for each command.\n This behaviour is triggered by passing the ``--stubs`` flag to the script.\n In this case, an output file must be provided with a filename ending in \".h\",\n and the callback stubs will be written to an equivalent \".c\" file.\n@@ -120,7 +120,7 @@ and the callback stubs will be written to an equivalent \".c\" file.\n .. note::\n \n The stubs are written to a separate file,\n- to allow continuous use of the script to regenerate the command-line header,\n+ to allow continuous use of the script to regenerate the command-line header\n without overwriting any code the user has added to the callback functions.\n This makes it easy to incrementally add new commands to an existing application.\n \n@@ -154,7 +154,7 @@ the callback functions would be:\n These functions must be provided by the developer. However, as stated above,\n stub functions may be generated by the script automatically using the ``--stubs`` parameter.\n \n-The same \"cmdname\" stem is used in the naming of the generated structures too.\n+The same \"cmdname\" stem is used in the naming of the generated structures as well.\n To get to the results structure for each command above,\n the ``parsed_result`` parameter should be cast to ``struct cmd_quit_result``\n or ``struct cmd_show_port_stats_result`` respectively.\n@@ -176,13 +176,12 @@ Integrating with the Application\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n To integrate the script output with the application,\n-we must ``#include`` the generated header into our applications C file,\n+we must ``#include`` the generated header into our application's C file,\n and then have the command-line created via either ``cmdline_new`` or ``cmdline_stdin_new``.\n The first parameter to the function call should be the context array in the generated header file,\n ``ctx`` by default (Modifiable via script parameter).\n \n-The callback functions may be in this same file, or in a separate one -\n-they just need to be available to the linker at build-time.\n+The callback functions may be in the same or separate file, as long as they are available to the linker at build-time.\n \n Limitations of the Script Approach\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n@@ -242,19 +241,19 @@ The resulting struct looks like:\n \n As before, we choose names to match the tokens in the command.\n Since our numeric parameter is a 16-bit value, we use ``uint16_t`` type for it.\n-Any of the standard sized integer types can be used as parameters, depending on the desired result.\n+Any of the standard-sized integer types can be used as parameters depending on the desired result.\n \n Beyond the standard integer types,\n-the library also allows variable parameters to be of a number of other types,\n+the library also allows variable parameters to be of a number of other types\n as called out in the feature list above.\n \n * For variable string parameters,\n the type should be ``cmdline_fixed_string_t`` - the same as for fixed tokens,\n but these will be initialized differently (as described below).\n \n-* For ethernet addresses use type ``struct rte_ether_addr``\n+* For ethernet addresses, use type ``struct rte_ether_addr``\n \n-* For IP addresses use type ``cmdline_ipaddr_t``\n+* For IP addresses, use type ``cmdline_ipaddr_t``\n \n Providing Field Initializers\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n@@ -267,6 +266,7 @@ For fixed string tokens, like \"quit\", \"show\" and \"port\", the initializer will be\n static cmdline_parse_token_string_t cmd_quit_quit_tok =\n TOKEN_STRING_INITIALIZER(struct cmd_quit_result, quit, \"quit\");\n \n+\n The convention for naming used here is to include the base name of the overall result structure -\n ``cmd_quit`` in this case,\n as well as the name of the field within that structure - ``quit`` in this case, followed by ``_tok``.\n@@ -311,8 +311,8 @@ The callback function should have type:\n where the first parameter is a pointer to the result structure defined above,\n the second parameter is the command-line instance,\n and the final parameter is a user-defined pointer provided when we associate the callback with the command.\n-Most callback functions only use the first parameter, or none at all,\n-but the additional two parameters provide some extra flexibility,\n+Most callback functions only use the first parameter or none at all,\n+but the additional two parameters provide some extra flexibility\n to allow the callback to work with non-global state in your application.\n \n For our two example commands, the relevant callback functions would look very similar in definition.\n@@ -341,7 +341,7 @@ Associating Callback and Command\n \n The ``cmdline_parse_inst_t`` type defines a \"parse instance\",\n i.e. a sequence of tokens to be matched and then an associated function to be called.\n-Also included in the instance type are a field for help text for the command,\n+Also included in the instance type are a field for help text for the command\n and any additional user-defined parameter to be passed to the callback functions referenced above.\n For example, for our simple \"quit\" command:\n \n@@ -362,8 +362,8 @@ then set the user-defined parameter to NULL,\n provide a help message to be given, on request, to the user explaining the command,\n before finally listing out the single token to be matched for this command instance.\n \n-For our second, port stats, example,\n-as well as making things a little more complicated by having multiple tokens to be matched,\n+For our second \"port stats\" example,\n+as well as making things more complex by having multiple tokens to be matched,\n we can also demonstrate passing in a parameter to the function.\n Let us suppose that our application does not always use all the ports available to it,\n but instead only uses a subset of the ports, stored in an array called ``active_ports``.\n", "prefixes": [ "7/9" ] }