Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/46306/?format=api
{ "id": 46306, "url": "https://patches.dpdk.org/api/patches/46306/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/20181009001616.10497-5-thomas@monjalon.net/", "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": "<20181009001616.10497-5-thomas@monjalon.net>", "list_archive_url": "https://inbox.dpdk.org/dev/20181009001616.10497-5-thomas@monjalon.net", "date": "2018-10-09T00:16:14", "name": "[v2,4/6] doc: replace doxygen example in contribution guide", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "93425927b2462abc360ed98023a52000ccb214a7", "submitter": { "id": 685, "url": "https://patches.dpdk.org/api/people/685/?format=api", "name": "Thomas Monjalon", "email": "thomas@monjalon.net" }, "delegate": { "id": 319, "url": "https://patches.dpdk.org/api/users/319/?format=api", "username": "fyigit", "first_name": "Ferruh", "last_name": "Yigit", "email": "ferruh.yigit@amd.com" }, "mbox": "https://patches.dpdk.org/project/dpdk/patch/20181009001616.10497-5-thomas@monjalon.net/mbox/", "series": [ { "id": 1766, "url": "https://patches.dpdk.org/api/series/1766/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=1766", "date": "2018-10-09T00:16:11", "name": "replace attach/detach functions", "version": 2, "mbox": "https://patches.dpdk.org/series/1766/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/46306/comments/", "check": "fail", "checks": "https://patches.dpdk.org/api/patches/46306/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 2EFCE1B444;\n\tTue, 9 Oct 2018 02:16:34 +0200 (CEST)", "from out3-smtp.messagingengine.com (out3-smtp.messagingengine.com\n\t[66.111.4.27]) by dpdk.org (Postfix) with ESMTP id 4A2D11B3B6\n\tfor <dev@dpdk.org>; Tue, 9 Oct 2018 02:16:26 +0200 (CEST)", "from compute1.internal (compute1.nyi.internal [10.202.2.41])\n\tby mailout.nyi.internal (Postfix) with ESMTP id E0C68220AD;\n\tMon, 8 Oct 2018 20:16:25 -0400 (EDT)", "from mailfrontend2 ([10.202.2.163])\n\tby compute1.internal (MEProxy); Mon, 08 Oct 2018 20:16:25 -0400", "from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184])\n\tby mail.messagingengine.com (Postfix) with ESMTPA id DA0E7102DD;\n\tMon, 8 Oct 2018 20:16:24 -0400 (EDT)" ], "DKIM-Signature": [ "v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h=\n\tfrom:to:cc:subject:date:message-id:in-reply-to:references\n\t:mime-version:content-transfer-encoding; s=mesmtp; bh=8NRvayZd3J\n\tFATbU2RvxDv1GtboOWjdvOrXUdYjr5CsA=; b=Z88opG/4g8yNg1iZzz/MmJOGsm\n\tho9DgZmhPsZRt+aeylAIKdahDF3xOzBT0PxM/KnIRZ0q9oWoOhAgXeAXi8KkztOf\n\tISTVby3Pn7FvunZvdYrUmsn/9ARM6XbhbgCg7uSIBwyITDG9kKeL/O+xgmlWJndW\n\t36LAczJbArO9U6q64=", "v=1; a=rsa-sha256; c=relaxed/relaxed; d=\n\tmessagingengine.com; h=cc:content-transfer-encoding:date:from\n\t:in-reply-to:message-id:mime-version:references:subject:to\n\t:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s=\n\tfm3; bh=8NRvayZd3JFATbU2RvxDv1GtboOWjdvOrXUdYjr5CsA=; b=I3qDfS77\n\tmuzcCMKQAjPxeJrUNPu6iX8mZ/Y4H8LoQMmKVw2VT6PgbYebfMBVFXDUzBFC0JbD\n\tEjv2tDa6PF5C1HUpa28YzNi4lL7y4t/+SSNMxlmkpeejcdMBSGdYOOoIcXCD64kM\n\tA3vJ4bM8yCtHfmzP7QfDp3HzNTXOv9PsRND9ER3ejptG3BpWNZ/ViVbbN3NFAw7g\n\tDsRUpdUgG31Ts27JOaytszA+cnYyz171Qu5UNgngRdNYiNiajj5fFRXqwfz8ekkM\n\tAgdSX4hQE9VkrNcxO39J2I/3zel42FNhT29XBp6JlpXE7mfLAnuQJZSOaQkZODC9\n\tBCiFCopBHIFC8A==" ], "X-ME-Sender": "<xms:WfO7W_GVW4kJkSIqE79cTque4KsnCsjIyqB0gpX7bixn8ijahLylcQ>", "X-ME-Proxy": "<xmx:WfO7W8uCE-4Ba9W1UmnVtpx4IpZPLOLEh0VJWX3xvu8R5yUaZiXNEg>\n\t<xmx:WfO7WyaQu2w3GxjBmkKOoD0ypIaFicvh3QL9e8tEDGfUVSV8gBGQ4w>\n\t<xmx:WfO7W5tv_kOCdmpYIjQBrk4g-hojeDLaMHuFD9oHo1z_gEqyv8wU8Q>\n\t<xmx:WfO7W8F5E7SQb22bgt1WkYm5SqQ7RF9VThj2OlNQJQwByqAUNRd2cg>\n\t<xmx:WfO7W8w0bHkt0Jy2_659uZfteL31m0yA10SxtHKXe7h056lUYgH_0g>\n\t<xmx:WfO7W8xz_pGZucfmr2Wrv2KYMbwnm2ucMtIB3SjFoMS7Ylf6QJMcUw>", "From": "Thomas Monjalon <thomas@monjalon.net>", "To": "dev@dpdk.org", "Cc": "gaetan.rivet@6wind.com, ophirmu@mellanox.com, ferruh.yigit@intel.com,\n\tarybchenko@solarflare.com", "Date": "Tue, 9 Oct 2018 02:16:14 +0200", "Message-Id": "<20181009001616.10497-5-thomas@monjalon.net>", "X-Mailer": "git-send-email 2.19.0", "In-Reply-To": "<20181009001616.10497-1-thomas@monjalon.net>", "References": "<20181007222554.4886-1-thomas@monjalon.net>\n\t<20181009001616.10497-1-thomas@monjalon.net>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[dpdk-dev] [PATCH v2 4/6] doc: replace doxygen example in\n\tcontribution guide", "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://mails.dpdk.org/options/dev>,\n\t<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\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "The provided example of doxygen header is about a deprecated function.\nIt is replaced by rte_spinlock_trylock() which is small and\ngood enough for the purpose.\n\nSigned-off-by: Thomas Monjalon <thomas@monjalon.net>\n---\n doc/guides/contributing/documentation.rst | 15 +++++----------\n 1 file changed, 5 insertions(+), 10 deletions(-)", "diff": "diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst\nindex 097575ad7..063c8b6c4 100644\n--- a/doc/guides/contributing/documentation.rst\n+++ b/doc/guides/contributing/documentation.rst\n@@ -615,19 +615,14 @@ The following are some guidelines for use of Doxygen in the DPDK API documentati\n .. code-block:: c\n \n /**\n- * Attach a new Ethernet device specified by arguments.\n- *\n- * @param devargs\n- * A pointer to a strings array describing the new device\n- * to be attached. The strings should be a pci address like\n- * `0000:01:00.0` or **virtual** device name like `net_pcap0`.\n- * @param port_id\n- * A pointer to a port identifier actually attached.\n+ * Try to take the lock.\n *\n+ * @param sl\n+ * A pointer to the spinlock.\n * @return\n- * 0 on success and port_id is filled, negative on error.\n+ * 1 if the lock is successfully taken; 0 otherwise.\n */\n- int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);\n+ int rte_spinlock_trylock (rte_spinlock_t *sl);\n \n * Doxygen supports Markdown style syntax such as bold, italics, fixed width text and lists.\n For example the second line in the ``devargs`` parameter in the previous example will be rendered as:\n", "prefixes": [ "v2", "4/6" ] }