Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/34203/?format=api
{ "id": 34203, "url": "http://patches.dpdk.org/api/patches/34203/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20180122014807.24654-6-nhorman@tuxdriver.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": "<20180122014807.24654-6-nhorman@tuxdriver.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20180122014807.24654-6-nhorman@tuxdriver.com", "date": "2018-01-22T01:48:07", "name": "[dpdk-dev,[PATCH,v5] 5/5] doc: Add ABI __experimental tag documentation", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "56163d07cd46aeb83e44d9e90eafa8903a595051", "submitter": { "id": 32, "url": "http://patches.dpdk.org/api/people/32/?format=api", "name": "Neil Horman", "email": "nhorman@tuxdriver.com" }, "delegate": null, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20180122014807.24654-6-nhorman@tuxdriver.com/mbox/", "series": [], "comments": "http://patches.dpdk.org/api/patches/34203/comments/", "check": "fail", "checks": "http://patches.dpdk.org/api/patches/34203/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 [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 2ADCD199B0;\n\tMon, 22 Jan 2018 02:48:57 +0100 (CET)", "from smtp.tuxdriver.com (charlotte.tuxdriver.com [70.61.120.58])\n\tby dpdk.org (Postfix) with ESMTP id 404A4A495\n\tfor <dev@dpdk.org>; Mon, 22 Jan 2018 02:48:56 +0100 (CET)", "from cpe-2606-a000-111b-4011-eaa3-4b92-4a68-8f24.dyn6.twc.com\n\t([2606:a000:111b:4011:eaa3:4b92:4a68:8f24]\n\thelo=hmswarspite.think-freely.org)\n\tby smtp.tuxdriver.com with esmtpsa (TLSv1:AES256-SHA:256) (Exim 4.63)\n\t(envelope-from <nhorman@tuxdriver.com>)\n\tid 1edRE5-00068B-US; Sun, 21 Jan 2018 20:48:53 -0500", "from hmswarspite.think-freely.org (localhost [127.0.0.1])\n\tby hmswarspite.think-freely.org (8.15.2/8.15.2) with ESMTP id\n\tw0M1mDl0024837; Sun, 21 Jan 2018 20:48:13 -0500", "(from nhorman@localhost)\n\tby hmswarspite.think-freely.org (8.15.2/8.15.2/Submit) id\n\tw0M1mDGM024818; Sun, 21 Jan 2018 20:48:13 -0500" ], "From": "Neil Horman <nhorman@tuxdriver.com>", "To": "dev@dpdk.org", "Cc": "Neil Horman <nhorman@tuxdriver.com>,\n\tThomas Monjalon <thomas@monjalon.net>, \n\t\"Mcnamara, John\" <john.mcnamara@intel.com>,\n\tBruce Richardson <bruce.richardson@intel.com>", "Date": "Sun, 21 Jan 2018 20:48:07 -0500", "Message-Id": "<20180122014807.24654-6-nhorman@tuxdriver.com>", "X-Mailer": "git-send-email 2.14.3", "In-Reply-To": "<20180122014807.24654-1-nhorman@tuxdriver.com>", "References": "<20171201185628.16261-1-nhorman@tuxdriver.com>\n\t<20180122014807.24654-1-nhorman@tuxdriver.com>", "X-Spam-Score": "-2.9 (--)", "X-Spam-Status": "No", "Subject": "[dpdk-dev] [[PATCH v5] 5/5] doc: Add ABI __experimental tag\n\tdocumentation", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://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": "<https://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": "Document the need to add the __experimental tag to appropriate functions\n\nSigned-off-by: Neil Horman <nhorman@tuxdriver.com>\nCC: Thomas Monjalon <thomas@monjalon.net>\nCC: \"Mcnamara, John\" <john.mcnamara@intel.com>\nCC: Bruce Richardson <bruce.richardson@intel.com>\n---\n doc/guides/contributing/versioning.rst | 14 ++++++++++++++\n 1 file changed, 14 insertions(+)", "diff": "diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst\nindex 400090628..b4de9ed04 100644\n--- a/doc/guides/contributing/versioning.rst\n+++ b/doc/guides/contributing/versioning.rst\n@@ -50,6 +50,20 @@ those new APIs and start finding issues with them, new DPDK APIs will be\n automatically marked as ``experimental`` to allow for a period of stabilization\n before they become part of a tracked ABI.\n \n+Note that marking an API as experimental is a multi step process. To mark an API\n+as experimental, the symbols which are desired to be exported must be placed in\n+an EXPERIMENTAL version block in the corresponding libraries' version map\n+script. Secondly, the corresponding definitions of those exported functions, and\n+their forward declarations (in the development header files), must be marked\n+with the __rte_experimental tag (see rte_compat.h). The DPDK build makefiles\n+perform a check to ensure that the map file and the C code reflect the same\n+list of symbols. This check can be circumvented by defining\n+ALLOW_EXPERIMENTAL_API during compilation in the corresponding library Makefile.\n+\n+In addition to tagging the code with __rte_experimental, the\n+doxygen markup must also contain the EXPERIMENTAL string, and the MAINTAINER\n+file should note that the library contains EXPERIMENTAL APIs.\n+\n ABI versions, once released, are available until such time as their\n deprecation has been noted in the Release Notes for at least one major release\n cycle. For example consider the case where the ABI for DPDK 2.0 has been\n", "prefixes": [ "dpdk-dev", "[PATCH", "v5" ] }