Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/134791/?format=api
{ "id": 134791, "url": "http://patches.dpdk.org/api/patches/134791/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20231204102429.106709-4-juraj.linkes@pantheon.tech/", "project": { "id": 1, "url": "http://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": "<20231204102429.106709-4-juraj.linkes@pantheon.tech>", "list_archive_url": "https://inbox.dpdk.org/dev/20231204102429.106709-4-juraj.linkes@pantheon.tech", "date": "2023-12-04T10:24:11", "name": "[v9,03/21] dts: add basic developer docs", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "1058edf6ccee014c0594e0291f89dcad3589441b", "submitter": { "id": 1626, "url": "http://patches.dpdk.org/api/people/1626/?format=api", "name": "Juraj Linkeš", "email": "juraj.linkes@pantheon.tech" }, "delegate": { "id": 1, "url": "http://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20231204102429.106709-4-juraj.linkes@pantheon.tech/mbox/", "series": [ { "id": 30441, "url": "http://patches.dpdk.org/api/series/30441/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30441", "date": "2023-12-04T10:24:08", "name": "dts: docstrings update", "version": 9, "mbox": "http://patches.dpdk.org/series/30441/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/134791/comments/", "check": "warning", "checks": "http://patches.dpdk.org/api/patches/134791/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 AB6114366A;\n\tMon, 4 Dec 2023 11:24:55 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id D0E4E40EDB;\n\tMon, 4 Dec 2023 11:24:36 +0100 (CET)", "from mail-wm1-f53.google.com (mail-wm1-f53.google.com\n [209.85.128.53]) by mails.dpdk.org (Postfix) with ESMTP id 031A640DFD\n for <dev@dpdk.org>; Mon, 4 Dec 2023 11:24:34 +0100 (CET)", "by mail-wm1-f53.google.com with SMTP id\n 5b1f17b1804b1-40c09f5a7cfso11129755e9.0\n for <dev@dpdk.org>; Mon, 04 Dec 2023 02:24:34 -0800 (PST)", "from jlinkes-PT-Latitude-5530.pantheon.local ([81.89.53.154])\n by smtp.gmail.com with ESMTPSA id\n m28-20020a05600c3b1c00b0040b2b38a1fasm14255415wms.4.2023.12.04.02.24.32\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Mon, 04 Dec 2023 02:24:33 -0800 (PST)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=pantheon.tech; s=google; t=1701685473; x=1702290273; darn=dpdk.org;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:from:to:cc:subject:date\n :message-id:reply-to;\n bh=ZYiXW2Z88ESYnyFNqmTUgTLHumo8eKturZmLII8hMZI=;\n b=eNfjMMfB5HTPkS89EsXPMYZEn0EMkLhxjz8ppcgTfCu2eBmjOcA7uTRmZ3ZsmIyoLt\n mM385Rs9qymuwTilo7PcMyyjeHdcNGN8aIaas5EW09gHYmYIm1XTU6Eu05/vGwe5PUUJ\n oNNcYothAqgXpPPXiW8A0/YA7RUAvr9fxGheFnQH06Uev2zR4P63pkPCL+LUala5f88P\n bCqkJnYyyHc+Hddn2cGIxR1weaGF6KTUy6nFwKQI9HdJ8MDgkctZM/5fVBSc10O4cNY/\n 0PpXv4NQ6xGjTSOLTPJ9c7kjs3G1iYKdbpI4drJlr4FHC+gVN+JzgwUGQWbw/zpSKyEU\n KAlA==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1701685473; x=1702290273;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc\n :subject:date:message-id:reply-to;\n bh=ZYiXW2Z88ESYnyFNqmTUgTLHumo8eKturZmLII8hMZI=;\n b=EW4KdTR8pnbOXiG4upq/zDRGhIu7KJrQ7oWQDWAruudTe/Y8x/SVUVTPS3FtrF+E/T\n 7at3ufOevPhyVn0KQ8p1i/vaFr1Xa0/XPLNblRQXA1bGkQW+ED5MpkhLm6cR1CI71pNE\n +GMvHCzcDeNqdUL1y94G7saVgzPvmScg5sYWh07uRVLhpxExDYz7G5IKh2ZEh9CEEED4\n Fcw+ON5JRU/vZbFoNC6s1RiTtm4tn/AII31bqoE7KaLsFnVrK3FH2vKWB6BPsvytbBf3\n 5goHipm2r7/+76rgPVUdgBMl7bm0phonGNymMqKRx392pffPkNYaiXJcDcXmZYv/NmNk\n t7zA==", "X-Gm-Message-State": "AOJu0Yz1OhLMIAhnUk77olD0PbtR9mYR0X+HD61gBULwvS3qaY8lHLNo\n u55Os9QGAOQX95QWa554NAoeHXQ/XNqu8U8xiAPzxQ==", "X-Google-Smtp-Source": "\n AGHT+IGgjtgagnPp0taT88/COgyUFNq9wHVVFcUXkW6c7nmCnMswgp8L4vb0MhUhEMX65voqKn7hnQ==", "X-Received": "by 2002:a05:600c:3647:b0:40b:5e59:e9fe with SMTP id\n y7-20020a05600c364700b0040b5e59e9femr2587244wmq.157.1701685473725;\n Mon, 04 Dec 2023 02:24:33 -0800 (PST)", "From": "=?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "To": "thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, jspewock@iol.unh.edu,\n probb@iol.unh.edu, paul.szczepanek@arm.com, yoan.picchi@foss.arm.com,\n Luca.Vizzarro@arm.com", "Cc": "dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "Subject": "[PATCH v9 03/21] dts: add basic developer docs", "Date": "Mon, 4 Dec 2023 11:24:11 +0100", "Message-Id": "<20231204102429.106709-4-juraj.linkes@pantheon.tech>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20231204102429.106709-1-juraj.linkes@pantheon.tech>", "References": "<20231123151344.162812-1-juraj.linkes@pantheon.tech>\n <20231204102429.106709-1-juraj.linkes@pantheon.tech>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "Content-Transfer-Encoding": "8bit", "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": "Expand the framework contribution guidelines and add how to document the\ncode with Python docstrings.\n\nSigned-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>\n---\n doc/guides/tools/dts.rst | 73 ++++++++++++++++++++++++++++++++++++++++\n 1 file changed, 73 insertions(+)", "diff": "diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst\nindex 32c18ee472..cd771a428c 100644\n--- a/doc/guides/tools/dts.rst\n+++ b/doc/guides/tools/dts.rst\n@@ -264,6 +264,65 @@ which be changed with the ``--output-dir`` command line argument.\n The results contain basic statistics of passed/failed test cases and DPDK version.\n \n \n+Contributing to DTS\n+-------------------\n+\n+There are two areas of contribution: The DTS framework and DTS test suites.\n+\n+The framework contains the logic needed to run test cases, such as connecting to nodes,\n+running DPDK apps and collecting results.\n+\n+The test cases call APIs from the framework to test their scenarios. Adding test cases may\n+require adding code to the framework as well.\n+\n+\n+Framework Coding Guidelines\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+When adding code to the DTS framework, pay attention to the rest of the code\n+and try not to divert much from it. The :ref:`DTS developer tools <dts_dev_tools>` will issue\n+warnings when some of the basics are not met.\n+\n+The code must be properly documented with docstrings. The style must conform to\n+the `Google style <https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings>`_.\n+See an example of the style\n+`here <https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html>`_.\n+For cases which are not covered by the Google style, refer\n+to `PEP 257 <https://peps.python.org/pep-0257/>`_. There are some cases which are not covered by\n+the two style guides, where we deviate or where some additional clarification is helpful:\n+\n+ * The __init__() methods of classes are documented separately from the docstring of the class\n+ itself.\n+ * The docstrigs of implemented abstract methods should refer to the superclass's definition\n+ if there's no deviation.\n+ * Instance variables/attributes should be documented in the docstring of the class\n+ in the ``Attributes:`` section.\n+ * The dataclass.dataclass decorator changes how the attributes are processed. The dataclass\n+ attributes which result in instance variables/attributes should also be recorded\n+ in the ``Attributes:`` section.\n+ * Class variables/attributes, on the other hand, should be documented with ``#:`` above\n+ the type annotated line. The description may be omitted if the meaning is obvious.\n+ * The Enum and TypedDict also process the attributes in particular ways and should be documented\n+ with ``#:`` as well. This is mainly so that the autogenerated docs contain the assigned value.\n+ * When referencing a parameter of a function or a method in their docstring, don't use\n+ any articles and put the parameter into single backticks. This mimics the style of\n+ `Python's documentation <https://docs.python.org/3/index.html>`_.\n+ * When specifying a value, use double backticks::\n+\n+ def foo(greet: bool) -> None:\n+ \"\"\"Demonstration of single and double backticks.\n+\n+ `greet` controls whether ``Hello World`` is printed.\n+\n+ Args:\n+ greet: Whether to print the ``Hello World`` message.\n+ \"\"\"\n+ if greet:\n+ print(f\"Hello World\")\n+\n+ * The docstring maximum line length is the same as the code maximum line length.\n+\n+\n How To Write a Test Suite\n -------------------------\n \n@@ -293,6 +352,18 @@ There are four types of methods that comprise a test suite:\n | These methods don't need to be implemented if there's no need for them in a test suite.\n In that case, nothing will happen when they're is executed.\n \n+#. **Configuration, traffic and other logic**\n+\n+ The ``TestSuite`` class contains a variety of methods for anything that\n+ a test suite setup, a teardown, or a test case may need to do.\n+\n+ The test suites also frequently use a DPDK app, such as testpmd, in interactive mode\n+ and use the interactive shell instances directly.\n+\n+ These are the two main ways to call the framework logic in test suites. If there's any\n+ functionality or logic missing from the framework, it should be implemented so that\n+ the test suites can use one of these two ways.\n+\n #. **Test case verification**\n \n Test case verification should be done with the ``verify`` method, which records the result.\n@@ -308,6 +379,8 @@ There are four types of methods that comprise a test suite:\n and used by the test suite via the ``sut_node`` field.\n \n \n+.. _dts_dev_tools:\n+\n DTS Developer Tools\n -------------------\n \n", "prefixes": [ "v9", "03/21" ] }