Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/130511/?format=api
{ "id": 130511, "url": "http://patches.dpdk.org/api/patches/130511/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20230818092943.1771-1-anoobj@marvell.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": "<20230818092943.1771-1-anoobj@marvell.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20230818092943.1771-1-anoobj@marvell.com", "date": "2023-08-18T09:29:42", "name": "[1/2] doc: fix code blocks in security guide", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "cbdb96983c2d43d89b817de1ccf9dd14726f4646", "submitter": { "id": 1205, "url": "http://patches.dpdk.org/api/people/1205/?format=api", "name": "Anoob Joseph", "email": "anoobj@marvell.com" }, "delegate": { "id": 6690, "url": "http://patches.dpdk.org/api/users/6690/?format=api", "username": "akhil", "first_name": "akhil", "last_name": "goyal", "email": "gakhil@marvell.com" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20230818092943.1771-1-anoobj@marvell.com/mbox/", "series": [ { "id": 29276, "url": "http://patches.dpdk.org/api/series/29276/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=29276", "date": "2023-08-18T09:29:42", "name": "[1/2] doc: fix code blocks in security guide", "version": 1, "mbox": "http://patches.dpdk.org/series/29276/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/130511/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/130511/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 1638343095;\n\tFri, 18 Aug 2023 11:29:57 +0200 (CEST)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 8C3CF40ED9;\n\tFri, 18 Aug 2023 11:29:56 +0200 (CEST)", "from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com\n [67.231.148.174])\n by mails.dpdk.org (Postfix) with ESMTP id DE88440395\n for <dev@dpdk.org>; Fri, 18 Aug 2023 11:29:54 +0200 (CEST)", "from pps.filterd (m0045849.ppops.net [127.0.0.1])\n by mx0a-0016f401.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id\n 37I8bKJs014092; Fri, 18 Aug 2023 02:29:53 -0700", "from dc5-exch01.marvell.com ([199.233.59.181])\n by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 3sj59y042s-1\n (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT);\n Fri, 18 Aug 2023 02:29:53 -0700", "from DC5-EXCH02.marvell.com (10.69.176.39) by DC5-EXCH01.marvell.com\n (10.69.176.38) with Microsoft SMTP Server (TLS) id 15.0.1497.48;\n Fri, 18 Aug 2023 02:29:45 -0700", "from maili.marvell.com (10.69.176.80) by DC5-EXCH02.marvell.com\n (10.69.176.39) with Microsoft SMTP Server id 15.0.1497.48 via Frontend\n Transport; Fri, 18 Aug 2023 02:29:45 -0700", "from BG-LT92004.corp.innovium.com (unknown [10.28.163.189])\n by maili.marvell.com (Postfix) with ESMTP id 238C13F7048;\n Fri, 18 Aug 2023 02:29:42 -0700 (PDT)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com;\n h=from : to : cc :\n subject : date : message-id : mime-version : content-transfer-encoding :\n content-type; s=pfpt0220; bh=uP3o84eYeBy9BoPFFO7mRD4Pp50NymwpguFw6UieYsY=;\n b=Qsix0FtPiOyEVWheB84R4zzTat4di79h6QeX+iGiE+ccoQW5hdu2Lkn7gv+nuSzPv5J5\n uT4me6YIcmDCTFEHzYSyWVpcnIE1mEkpOh6HtGEM093jhxtJib2hhXmMjWrjTaH6d+Nr\n 25kdTMEmU07Qc/NF2jZsWLWDg55g0I8CMdTyoGB6fjR8rAABfHSf7yeG7VSmEWOz5DEV\n XsnbDqqdKkPu6X5PSSxU9hs350dPxBCG8lmhdXq6lAh65Vnw3AXsneb4yN59t4O55KaS\n zBVcUmsKWte0zQpbhf9g7XP8hS3GJ8vKbHl1r9uFqlDy5ioDNxn1yZWRtA9HS7BdnEl2 UA==", "From": "Anoob Joseph <anoobj@marvell.com>", "To": "Thomas Monjalon <thomas@monjalon.net>, Akhil Goyal <gakhil@marvell.com>,\n Jerin Jacob <jerinj@marvell.com>", "CC": "Bruce Richardson <bruce.richardson@intel.com>, <dev@dpdk.org>", "Subject": "[PATCH 1/2] doc: fix code blocks in security guide", "Date": "Fri, 18 Aug 2023 14:59:42 +0530", "Message-ID": "<20230818092943.1771-1-anoobj@marvell.com>", "X-Mailer": "git-send-email 2.25.1", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Content-Type": "text/plain", "X-Proofpoint-ORIG-GUID": "ufOp6sHJcVXdE0PSWVSIvPnJ9X0Wq4aa", "X-Proofpoint-GUID": "ufOp6sHJcVXdE0PSWVSIvPnJ9X0Wq4aa", "X-Proofpoint-Virus-Version": "vendor=baseguard\n engine=ICAP:2.0.267,Aquarius:18.0.957,Hydra:6.0.601,FMLib:17.11.176.26\n definitions=2023-08-18_11,2023-08-17_02,2023-05-22_02", "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": "Add literal includes to copy code block while compiling. Having a copy\nmay lead to mismatch if code is updated without updating the doc.\n\nFixes: 40ff8c99ea99 (\"doc: add details of security library\")\n\nSigned-off-by: Anoob Joseph <anoobj@marvell.com>\n---\n doc/guides/prog_guide/rte_security.rst | 65 +++++---------------------\n lib/security/rte_security.h | 6 +++\n 2 files changed, 18 insertions(+), 53 deletions(-)", "diff": "diff --git a/doc/guides/prog_guide/rte_security.rst b/doc/guides/prog_guide/rte_security.rst\nindex 7418e35c1b..ae8b0aaef3 100644\n--- a/doc/guides/prog_guide/rte_security.rst\n+++ b/doc/guides/prog_guide/rte_security.rst\n@@ -671,68 +671,27 @@ Security session configuration\n \n Security Session configuration structure is defined as ``rte_security_session_conf``\n \n-.. code-block:: c\n-\n- struct rte_security_session_conf {\n- enum rte_security_session_action_type action_type;\n- /**< Type of action to be performed on the session */\n- enum rte_security_session_protocol protocol;\n- /**< Security protocol to be configured */\n- union {\n- struct rte_security_ipsec_xform ipsec;\n- struct rte_security_macsec_xform macsec;\n- struct rte_security_pdcp_xform pdcp;\n- struct rte_security_docsis_xform docsis;\n- };\n- /**< Configuration parameters for security session */\n- struct rte_crypto_sym_xform *crypto_xform;\n- /**< Security Session Crypto Transformations */\n- void *userdata;\n- /**< Application specific userdata to be saved with session */\n- };\n+.. literalinclude:: ../../../lib/security/rte_security.h\n+ :language: c\n+ :start-after: Structure rte_security_session_conf 8<\n+ :end-before: >8 End of structure rte_security_session_conf.\n \n The configuration structure reuses the ``rte_crypto_sym_xform`` struct for crypto related\n configuration. The ``rte_security_session_action_type`` struct is used to specify whether the\n session is configured for Lookaside Protocol offload or Inline Crypto or Inline Protocol\n Offload.\n \n-.. code-block:: c\n-\n- enum rte_security_session_action_type {\n- RTE_SECURITY_ACTION_TYPE_NONE,\n- /**< No security actions */\n- RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO,\n- /**< Crypto processing for security protocol is processed inline\n- * during transmission\n- */\n- RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL,\n- /**< All security protocol processing is performed inline during\n- * transmission\n- */\n- RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL,\n- /**< All security protocol processing including crypto is performed\n- * on a lookaside accelerator\n- */\n- RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO\n- /**< Similar to ACTION_TYPE_NONE but crypto processing for security\n- * protocol is processed synchronously by a CPU.\n- */\n- };\n+.. literalinclude:: ../../../lib/security/rte_security.h\n+ :language: c\n+ :start-after: Enumeration of rte_security_session_action_type 8<\n+ :end-before: >8 End enumeration of rte_security_session_action_type.\n \n The ``rte_security_session_protocol`` is defined as\n \n-.. code-block:: c\n-\n- enum rte_security_session_protocol {\n- RTE_SECURITY_PROTOCOL_IPSEC = 1,\n- /**< IPsec Protocol */\n- RTE_SECURITY_PROTOCOL_MACSEC,\n- /**< MACSec Protocol */\n- RTE_SECURITY_PROTOCOL_PDCP,\n- /**< PDCP Protocol */\n- RTE_SECURITY_PROTOCOL_DOCSIS,\n- /**< DOCSIS Protocol */\n- };\n+.. literalinclude:: ../../../lib/security/rte_security.h\n+ :language: c\n+ :start-after: Enumeration of rte_security_session_protocol 8<\n+ :end-before: >8 End enumeration of rte_security_session_protocol.\n \n Currently the library defines configuration parameters for IPsec and PDCP only.\n For other protocols like MACSec, structures and enums are defined as place holders\ndiff --git a/lib/security/rte_security.h b/lib/security/rte_security.h\nindex 35ddf208a7..c908c428ad 100644\n--- a/lib/security/rte_security.h\n+++ b/lib/security/rte_security.h\n@@ -634,6 +634,7 @@ struct rte_security_docsis_xform {\n /**\n * Security session action type.\n */\n+/* Enumeration of rte_security_session_action_type 8<*/\n enum rte_security_session_action_type {\n \tRTE_SECURITY_ACTION_TYPE_NONE,\n \t/**< No security actions */\n@@ -654,8 +655,10 @@ enum rte_security_session_action_type {\n \t * protocol is processed synchronously by a CPU.\n \t */\n };\n+/* >8 End enumeration of rte_security_session_action_type. */\n \n /** Security session protocol definition */\n+/* Enumeration of rte_security_session_protocol 8<*/\n enum rte_security_session_protocol {\n \tRTE_SECURITY_PROTOCOL_IPSEC = 1,\n \t/**< IPsec Protocol */\n@@ -666,10 +669,12 @@ enum rte_security_session_protocol {\n \tRTE_SECURITY_PROTOCOL_DOCSIS,\n \t/**< DOCSIS Protocol */\n };\n+/* >8 End enumeration of rte_security_session_protocol. */\n \n /**\n * Security session configuration\n */\n+/* Structure rte_security_session_conf 8< */\n struct rte_security_session_conf {\n \tenum rte_security_session_action_type action_type;\n \t/**< Type of action to be performed on the session */\n@@ -688,6 +693,7 @@ struct rte_security_session_conf {\n \tvoid *userdata;\n \t/**< Application specific userdata to be saved with session */\n };\n+/* >8 End of structure rte_security_session_conf. */\n \n /**\n * Create security session as specified by the session configuration\n", "prefixes": [ "1/2" ] }