Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/2337/?format=api
{ "id": 2337, "url": "https://patches.dpdk.org/api/patches/2337/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/1421422389-5473-4-git-send-email-nhorman@tuxdriver.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": "<1421422389-5473-4-git-send-email-nhorman@tuxdriver.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1421422389-5473-4-git-send-email-nhorman@tuxdriver.com", "date": "2015-01-16T15:33:09", "name": "[dpdk-dev,v5,4/4] docs: Add ABI documentation", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "87821780682e50ea5c61638f60a4adad738780db", "submitter": { "id": 32, "url": "https://patches.dpdk.org/api/people/32/?format=api", "name": "Neil Horman", "email": "nhorman@tuxdriver.com" }, "delegate": null, "mbox": "https://patches.dpdk.org/project/dpdk/patch/1421422389-5473-4-git-send-email-nhorman@tuxdriver.com/mbox/", "series": [], "comments": "https://patches.dpdk.org/api/patches/2337/comments/", "check": "pending", "checks": "https://patches.dpdk.org/api/patches/2337/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [IPv6:::1])\n\tby dpdk.org (Postfix) with ESMTP id CE19A5AB7;\n\tFri, 16 Jan 2015 16:33:46 +0100 (CET)", "from smtp.tuxdriver.com (charlotte.tuxdriver.com [70.61.120.58])\n\tby dpdk.org (Postfix) with ESMTP id 7B8635AB7\n\tfor <dev@dpdk.org>; Fri, 16 Jan 2015 16:33:44 +0100 (CET)", "from hmsreliant.think-freely.org\n\t([2001:470:8:a08:7aac:c0ff:fec2:933b] helo=localhost)\n\tby smtp.tuxdriver.com with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.63)\n\t(envelope-from <nhorman@tuxdriver.com>)\n\tid 1YC8u3-00088U-Bw; Fri, 16 Jan 2015 10:33:41 -0500" ], "From": "Neil Horman <nhorman@tuxdriver.com>", "To": "dev@dpdk.org", "Date": "Fri, 16 Jan 2015 10:33:09 -0500", "Message-Id": "<1421422389-5473-4-git-send-email-nhorman@tuxdriver.com>", "X-Mailer": "git-send-email 2.1.0", "In-Reply-To": "<1421422389-5473-1-git-send-email-nhorman@tuxdriver.com>", "References": "<1419109299-9603-1-git-send-email-nhorman@tuxdriver.com>\n\t<1421422389-5473-1-git-send-email-nhorman@tuxdriver.com>", "X-Spam-Score": "-2.9 (--)", "X-Spam-Status": "No", "Subject": "[dpdk-dev] [PATCH v5 4/4] docs: Add ABI documentation", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "patches and discussions about DPDK <dev.dpdk.org>", "List-Unsubscribe": "<http://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<http://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Adding a document describing rudimentary ABI policy and adding notice space for\nany deprecation announcements\n\nSigned-off-by: Neil Horman <nhorman@tuxdriver.com>\nCC: Thomas Monjalon <thomas.monjalon@6wind.com>\nCC: \"Richardson, Bruce\" <bruce.richardson@intel.com>\n\n---\nChange notes:\n\nv5) Updated documentation to add notes from Thomas M.\n---\n doc/abi.txt | 36 ++++++++++++++++++++++++++++++++++++\n 1 file changed, 36 insertions(+)\n create mode 100644 doc/abi.txt", "diff": "diff --git a/doc/abi.txt b/doc/abi.txt\nnew file mode 100644\nindex 0000000..14be464\n--- /dev/null\n+++ b/doc/abi.txt\n@@ -0,0 +1,36 @@\n+ABI policy:\n+\tABI versions are set at the time of major release labeling, and ABI may\n+change multiple times between the last labeling and the HEAD label of the git\n+tree without warning\n+\n+\tABI versions, once released are available until such time as their\n+deprecation has been noted here for at least one major release cycle, after it\n+has been tagged. E.g. the ABI for DPDK 1.8 is shipped, and then the decision to\n+remove it is made during the development of DPDK 1.9. The decision will be\n+recorded here, shipped with the DPDK 1.9 release, and actually removed when DPDK\n+1.10 ships.\n+\n+\tABI versions may be deprecated in whole, or in part as needed by a given\n+update.\n+\n+\tSome ABI changes may be too significant to reasonably maintain multiple\n+versions of. In those events ABI's may be updated without backward\n+compatibility provided. The requirements for doing so are:\n+\t1) At least 3 acknoweldgements of the need on the dpdk.org\n+\t2) A full deprecation cycle must be made to offer downstream consumers\n+sufficient warning of the change. E.g. if dpdk 2.0 is under development when\n+the change is proposed, a deprecation notice must be added to this file, and\n+released with dpdk 2.0. Then the change may be incorporated for dpdk 2.1\n+\t3) The LIBABIVER variable in the makefilei(s) where the ABI changes are\n+incorporated must be incremented in parallel with the ABI changes themselves\n+\n+\tNote that the above process for ABI deprecation should not be undertaken\n+lightly. ABI stability is extreemely important for downstream consumers of the\n+DPDK, especially when distributed in shared object form. Every effort should be\n+made to preserve ABI whenever possible. For instance, reorganizing public\n+structure field for astetic or readability purposes should be avoided as it will\n+cause ABI breakage. Only significant (e.g. performance) reasons should be seen\n+as cause to alter ABI.\n+ \n+Deprecation Notices:\n+\n", "prefixes": [ "dpdk-dev", "v5", "4/4" ] }