Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/134379/?format=api
{ "id": 134379, "url": "http://patches.dpdk.org/api/patches/134379/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20231115130959.39420-3-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": "<20231115130959.39420-3-juraj.linkes@pantheon.tech>", "list_archive_url": "https://inbox.dpdk.org/dev/20231115130959.39420-3-juraj.linkes@pantheon.tech", "date": "2023-11-15T13:09:40", "name": "[v7,02/21] dts: add docstring checker", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "0387f1a43249816b8b782d4e0b4447faa8eaa231", "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/20231115130959.39420-3-juraj.linkes@pantheon.tech/mbox/", "series": [ { "id": 30302, "url": "http://patches.dpdk.org/api/series/30302/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30302", "date": "2023-11-15T13:09:38", "name": "dts: docstrings update", "version": 7, "mbox": "http://patches.dpdk.org/series/30302/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/134379/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/134379/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 21A0843339;\n\tWed, 15 Nov 2023 14:11:54 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 0B07240294;\n\tWed, 15 Nov 2023 14:11:54 +0100 (CET)", "from mail-ej1-f45.google.com (mail-ej1-f45.google.com\n [209.85.218.45]) by mails.dpdk.org (Postfix) with ESMTP id 2A25240285\n for <dev@dpdk.org>; Wed, 15 Nov 2023 14:11:53 +0100 (CET)", "by mail-ej1-f45.google.com with SMTP id\n a640c23a62f3a-9c3aec5f326so166995566b.1\n for <dev@dpdk.org>; Wed, 15 Nov 2023 05:11:53 -0800 (PST)", "from jlinkes-PT-Latitude-5530.pantheon.local\n (81.89.53.154.host.vnet.sk. [81.89.53.154])\n by smtp.gmail.com with ESMTPSA id\n tb16-20020a1709078b9000b009f2b7282387sm1011914ejc.46.2023.11.15.05.11.11\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Wed, 15 Nov 2023 05:11:34 -0800 (PST)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=pantheon.tech; s=google; t=1700053913; x=1700658713; 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=U6/AvRBkllFQ+XgMDx3380G1DrnvTmtIBIE/1+tA3H8=;\n b=Oy8euVzdVDmXBE51sM2tjRomGEUAZFukMStD5znboNKBIlbFVdFf1dRyBS3M+kG+Yz\n mFBlhDCyXPheNThj1HnZ+j6t/uIptddehmz0vBPsBwtbMM3P+v4hj+3r/YWYwGXxNHZ2\n 5pJ/cLO1TPLy/vMOoxkW/LcVqUASbvW0SJJ+TpMCdgeO1MhkdkCp8l3qTZ+rI/5oVfvw\n BvUz37/UQmjXTHqcU8ONbaem3RrtubBldmdbFGbno2bD15hRL6cgYxT1Gq6qLO5ONvBS\n ZzQMT2a+p+Y8CxMmnkGoxqIMp0BSlfwa+qeWyqtNGLqOzBxeRYOrtKc+lehr9ckkyZbJ\n cA3Q==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1700053913; x=1700658713;\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=U6/AvRBkllFQ+XgMDx3380G1DrnvTmtIBIE/1+tA3H8=;\n b=iQ5EZswabEBKGcJmvfDsOO0KgEj3LywK64/+9+kYzfzvaQnXG3k970AYCLtz5DLXsX\n uyoTpwJe5WlgchBRGmC/A717LUT0G1BRlgDK4I6+qDruz+HZ1x/pE2zd9WwMpCtAfqUR\n L5SglHeX63HyWr7WnXtu9ncL+gf0n/SKKI0C8astBhESOwmwlrksVjKsUR43PGbdTWcs\n nNNy6CCvCrbGABhSYv9jVgHFmLuquSMQQfmhRHNocyoqtWWB//Wn5iBpwWSMsXGAHQGp\n q+4vqatgqaofc8w+HuDWaUjaGXUwm5eSQAZk+DFjvgjh3Eynn93jrapKc4vaB6sxHe8X\n 4FJA==", "X-Gm-Message-State": "AOJu0Yyxj7QcHuz8a/qhgqcBQqcepcdmvzgrZjKa9/GqYu3rJxx6+PKS\n SbfVkE50OPeT04p0b8dPLpyN9g==", "X-Google-Smtp-Source": "\n AGHT+IFp+kLpuF/aEMEp7qi3OrKxHwkTm94u5gzM+7fMioHrPLCdgITFbGbuejU3Cm6jVl1A5AwDKw==", "X-Received": "by 2002:a17:907:7256:b0:9d5:96e7:5ae1 with SMTP id\n ds22-20020a170907725600b009d596e75ae1mr5607971ejc.12.1700053912839;\n Wed, 15 Nov 2023 05:11:52 -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", "Cc": "dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "Subject": "[PATCH v7 02/21] dts: add docstring checker", "Date": "Wed, 15 Nov 2023 14:09:40 +0100", "Message-Id": "<20231115130959.39420-3-juraj.linkes@pantheon.tech>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20231115130959.39420-1-juraj.linkes@pantheon.tech>", "References": "<20231108125324.191005-23-juraj.linkes@pantheon.tech>\n <20231115130959.39420-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": "Python docstrings are the in-code way to document the code. The\ndocstring checker of choice is pydocstyle which we're executing from\nPylama, but the current latest versions are not complatible due to [0],\nso pin the pydocstyle version to the latest working version.\n\n[0] https://github.com/klen/pylama/issues/232\n\nSigned-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>\n---\n dts/poetry.lock | 12 ++++++------\n dts/pyproject.toml | 6 +++++-\n 2 files changed, 11 insertions(+), 7 deletions(-)", "diff": "diff --git a/dts/poetry.lock b/dts/poetry.lock\nindex f7b3b6d602..a734fa71f0 100644\n--- a/dts/poetry.lock\n+++ b/dts/poetry.lock\n@@ -489,20 +489,20 @@ files = [\n \n [[package]]\n name = \"pydocstyle\"\n-version = \"6.3.0\"\n+version = \"6.1.1\"\n description = \"Python docstring style checker\"\n optional = false\n python-versions = \">=3.6\"\n files = [\n- {file = \"pydocstyle-6.3.0-py3-none-any.whl\", hash = \"sha256:118762d452a49d6b05e194ef344a55822987a462831ade91ec5c06fd2169d019\"},\n- {file = \"pydocstyle-6.3.0.tar.gz\", hash = \"sha256:7ce43f0c0ac87b07494eb9c0b462c0b73e6ff276807f204d6b53edc72b7e44e1\"},\n+ {file = \"pydocstyle-6.1.1-py3-none-any.whl\", hash = \"sha256:6987826d6775056839940041beef5c08cc7e3d71d63149b48e36727f70144dc4\"},\n+ {file = \"pydocstyle-6.1.1.tar.gz\", hash = \"sha256:1d41b7c459ba0ee6c345f2eb9ae827cab14a7533a88c5c6f7e94923f72df92dc\"},\n ]\n \n [package.dependencies]\n-snowballstemmer = \">=2.2.0\"\n+snowballstemmer = \"*\"\n \n [package.extras]\n-toml = [\"tomli (>=1.2.3)\"]\n+toml = [\"toml\"]\n \n [[package]]\n name = \"pyflakes\"\n@@ -837,4 +837,4 @@ jsonschema = \">=4,<5\"\n [metadata]\n lock-version = \"2.0\"\n python-versions = \"^3.10\"\n-content-hash = \"0b1e4a1cb8323e17e5ee5951c97e74bde6e60d0413d7b25b1803d5b2bab39639\"\n+content-hash = \"3501e97b3dadc19fe8ae179fe21b1edd2488001da9a8e86ff2bca0b86b99b89b\"\ndiff --git a/dts/pyproject.toml b/dts/pyproject.toml\nindex 6762edfa6b..3943c87c87 100644\n--- a/dts/pyproject.toml\n+++ b/dts/pyproject.toml\n@@ -25,6 +25,7 @@ PyYAML = \"^6.0\"\n types-PyYAML = \"^6.0.8\"\n fabric = \"^2.7.1\"\n scapy = \"^2.5.0\"\n+pydocstyle = \"6.1.1\"\n \n [tool.poetry.group.dev.dependencies]\n mypy = \"^0.961\"\n@@ -39,10 +40,13 @@ requires = [\"poetry-core>=1.0.0\"]\n build-backend = \"poetry.core.masonry.api\"\n \n [tool.pylama]\n-linters = \"mccabe,pycodestyle,pyflakes\"\n+linters = \"mccabe,pycodestyle,pydocstyle,pyflakes\"\n format = \"pylint\"\n max_line_length = 88 # https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length\n \n+[tool.pylama.linter.pydocstyle]\n+convention = \"google\"\n+\n [tool.mypy]\n python_version = \"3.10\"\n enable_error_code = [\"ignore-without-code\"]\n", "prefixes": [ "v7", "02/21" ] }