Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/133836/?format=api
{ "id": 133836, "url": "http://patches.dpdk.org/api/patches/133836/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20231103132910.88333-1-bruce.richardson@intel.com/", "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": "<20231103132910.88333-1-bruce.richardson@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20231103132910.88333-1-bruce.richardson@intel.com", "date": "2023-11-03T13:29:10", "name": "doc/contributing: update RST text-wrapping guidelines", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "6ffcf5736fb2945ece5e51c2760b6ec423627898", "submitter": { "id": 20, "url": "http://patches.dpdk.org/api/people/20/?format=api", "name": "Bruce Richardson", "email": "bruce.richardson@intel.com" }, "delegate": { "id": 24651, "url": "http://patches.dpdk.org/api/users/24651/?format=api", "username": "dmarchand", "first_name": "David", "last_name": "Marchand", "email": "david.marchand@redhat.com" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20231103132910.88333-1-bruce.richardson@intel.com/mbox/", "series": [ { "id": 30136, "url": "http://patches.dpdk.org/api/series/30136/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30136", "date": "2023-11-03T13:29:10", "name": "doc/contributing: update RST text-wrapping guidelines", "version": 1, "mbox": "http://patches.dpdk.org/series/30136/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/133836/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/133836/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 9DEDC43279;\n\tFri, 3 Nov 2023 14:29:26 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 24C474027F;\n\tFri, 3 Nov 2023 14:29:26 +0100 (CET)", "from mgamail.intel.com (mgamail.intel.com [134.134.136.20])\n by mails.dpdk.org (Postfix) with ESMTP id 57D1F40273\n for <dev@dpdk.org>; Fri, 3 Nov 2023 14:29:24 +0100 (CET)", "from orsmga007.jf.intel.com ([10.7.209.58])\n by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 03 Nov 2023 06:29:21 -0700", "from unknown (HELO silpixa00401385.ir.intel.com) ([10.237.214.41])\n by orsmga007.jf.intel.com with ESMTP; 03 Nov 2023 06:29:21 -0700" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple;\n d=intel.com; i=@intel.com; q=dns/txt; s=Intel;\n t=1699018163; x=1730554163;\n h=from:to:cc:subject:date:message-id:mime-version:\n content-transfer-encoding;\n bh=BXVdmDTV9zVHV5QQfkC3r6GNFs+OV2d+vmxQzBESBEM=;\n b=Pmor1XonfZrohqgCdsNJmqrjx68V8ZgzNKPz6maHovwzRir9tQ0m8A4M\n 4VIudjn49uZI1oPARtg7bpgzrpo+9bvcZGBEjKpY4gp9HC7wbY8kG13DU\n Ofx5kqG8syLMztu5erBC2mdr+Lzm42ZXkrbGR4i3Vo4WVJnGsto6Dru6I\n pYGReklTjvwIrsXKIPJLQ0HWvu3B8UFEoIi9zSbr2gHqKaR++f8yIIAZG\n avfFunqIdABVhiokV4MDgRAj7GDBMxohbk69s3lTCy6dYukRyhMi8MXuu\n qI+N5cWEzxcPOyBUVYEHXMi/wPbrQg627LeFTK4gDe4WJSOWJsasi8GAs w==;", "X-IronPort-AV": [ "E=McAfee;i=\"6600,9927,10883\"; a=\"379343503\"", "E=Sophos;i=\"6.03,273,1694761200\"; d=\"scan'208\";a=\"379343503\"", "E=McAfee;i=\"6600,9927,10883\"; a=\"755157635\"", "E=Sophos;i=\"6.03,273,1694761200\"; d=\"scan'208\";a=\"755157635\"" ], "X-ExtLoop1": "1", "From": "Bruce Richardson <bruce.richardson@intel.com>", "To": "dev@dpdk.org", "Cc": "Bruce Richardson <bruce.richardson@intel.com>", "Subject": "[PATCH] doc/contributing: update RST text-wrapping guidelines", "Date": "Fri, 3 Nov 2023 13:29:10 +0000", "Message-Id": "<20231103132910.88333-1-bruce.richardson@intel.com>", "X-Mailer": "git-send-email 2.39.2", "MIME-Version": "1.0", "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": "Update and clarify the guidelines on how to wrap lines in our RST docs.\nWe no longer limit lines to just 80 characters, and what is more\nimportant that line length is the wrapping of sentences, starting a new\nsentence on a new line, and wrapping at punctuation.\n\nSigned-off-by: Bruce Richardson <bruce.richardson@intel.com>\n---\n doc/guides/contributing/documentation.rst | 16 +++++++++++-----\n 1 file changed, 11 insertions(+), 5 deletions(-)", "diff": "diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst\nindex 4eb62fc36a..9c90efb4ac 100644\n--- a/doc/guides/contributing/documentation.rst\n+++ b/doc/guides/contributing/documentation.rst\n@@ -234,12 +234,18 @@ The most common guidelines for writing RST text are detailed in the\n The additional guidelines below reiterate or expand upon those guidelines.\n \n \n-Line Length\n-~~~~~~~~~~~\n+Line Length and Wrapping\n+~~~~~~~~~~~~~~~~~~~~~~~~\n \n-* Lines in sentences should be less than 80 characters and wrapped at\n- words. Multiple sentences which are not separated by a blank line are joined\n- automatically into paragraphs.\n+* Documentation lines should be less than 100 characters.\n+\n+* Each sentence should start on a new line.\n+ Multiple sentences, which are not separated by a blank line,\n+ are joined automatically into paragraphs.\n+\n+* Wrap sentences at punctuation points, for example, at a comma.\n+ If no punctuation, put the newline at a logical point in the sentence,\n+ for example, at the end of a clause before an \"and\" or \"but\".\n \n * Lines in literal blocks should be less than 80 characters\n since they are not wrapped by the document formatters.\n", "prefixes": [] }