patch 'doc: replace code blocks with includes in security guide' has been queued to stable release 20.11.10

[luca.boccassi@gmail.com]

Hi,

FYI, your patch has been queued to stable release 20.11.10

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 10/21/23. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/bluca/dpdk-stable

This queued commit can be viewed at:
https://github.com/bluca/dpdk-stable/commit/029efa33a077190d28c82d1984f1e58c47586566

Thanks.

Luca Boccassi

---
From 029efa33a077190d28c82d1984f1e58c47586566 Mon Sep 17 00:00:00 2001
From: Anoob Joseph <anoobj@marvell.com>
Date: Fri, 18 Aug 2023 14:59:42 +0530
Subject: [PATCH] doc: replace code blocks with includes in security guide

[ upstream commit 03e3cfda1679998aa512464affb8dd293146364a ]

Add literal includes to copy code block while compiling. Having a copy
may lead to mismatch if code is updated without updating the doc.

Fixes: 40ff8c99ea99 ("doc: add details of security library")

Signed-off-by: Anoob Joseph <anoobj@marvell.com>
Acked-by: Akhil Goyal <gakhil@marvell.com>
---
 doc/guides/prog_guide/rte_security.rst | 65 +++++---------------------
 lib/librte_security/rte_security.h     |  6 +++
 2 files changed, 18 insertions(+), 53 deletions(-)

diff --git a/doc/guides/prog_guide/rte_security.rst b/doc/guides/prog_guide/rte_security.rst
index f72bc8a78f..2939771b87 100644
--- a/doc/guides/prog_guide/rte_security.rst
+++ b/doc/guides/prog_guide/rte_security.rst
@@ -583,68 +583,27 @@ Security session configuration
 
 Security Session configuration structure is defined as ``rte_security_session_conf``
 
-.. code-block:: c
-
-    struct rte_security_session_conf {
-        enum rte_security_session_action_type action_type;
-        /**< Type of action to be performed on the session */
-        enum rte_security_session_protocol protocol;
-        /**< Security protocol to be configured */
-        union {
-                struct rte_security_ipsec_xform ipsec;
-                struct rte_security_macsec_xform macsec;
-                struct rte_security_pdcp_xform pdcp;
-                struct rte_security_docsis_xform docsis;
-        };
-        /**< Configuration parameters for security session */
-        struct rte_crypto_sym_xform *crypto_xform;
-        /**< Security Session Crypto Transformations */
-        void *userdata;
-        /**< Application specific userdata to be saved with session */
-    };
+.. literalinclude:: ../../../lib/librte_security/rte_security.h
+   :language: c
+   :start-after: Structure rte_security_session_conf 8<
+   :end-before: >8 End of structure rte_security_session_conf.
 
 The configuration structure reuses the ``rte_crypto_sym_xform`` struct for crypto related
 configuration. The ``rte_security_session_action_type`` struct is used to specify whether the
 session is configured for Lookaside Protocol offload or Inline Crypto or Inline Protocol
 Offload.
 
-.. code-block:: c
-
-    enum rte_security_session_action_type {
-        RTE_SECURITY_ACTION_TYPE_NONE,
-        /**< No security actions */
-        RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO,
-        /**< Crypto processing for security protocol is processed inline
-         * during transmission
-         */
-        RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL,
-        /**< All security protocol processing is performed inline during
-         * transmission
-         */
-        RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL,
-        /**< All security protocol processing including crypto is performed
-         * on a lookaside accelerator
-         */
-        RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO
-        /**< Similar to ACTION_TYPE_NONE but crypto processing for security
-         * protocol is processed synchronously by a CPU.
-         */
-    };
+.. literalinclude:: ../../../lib/librte_security/rte_security.h
+   :language: c
+   :start-after: Enumeration of rte_security_session_action_type 8<
+   :end-before: >8 End enumeration of rte_security_session_action_type.
 
 The ``rte_security_session_protocol`` is defined as
 
-.. code-block:: c
-
-    enum rte_security_session_protocol {
-        RTE_SECURITY_PROTOCOL_IPSEC = 1,
-        /**< IPsec Protocol */
-        RTE_SECURITY_PROTOCOL_MACSEC,
-        /**< MACSec Protocol */
-        RTE_SECURITY_PROTOCOL_PDCP,
-        /**< PDCP Protocol */
-        RTE_SECURITY_PROTOCOL_DOCSIS,
-        /**< DOCSIS Protocol */
-    };
+.. literalinclude:: ../../../lib/librte_security/rte_security.h
+   :language: c
+   :start-after: Enumeration of rte_security_session_protocol 8<
+   :end-before: >8 End enumeration of rte_security_session_protocol.
 
 Currently the library defines configuration parameters for IPsec and PDCP only.
 For other protocols like MACSec, structures and enums are defined as place holders
diff --git a/lib/librte_security/rte_security.h b/lib/librte_security/rte_security.h
index 88d31de0a6..42895411c3 100644
--- a/lib/librte_security/rte_security.h
+++ b/lib/librte_security/rte_security.h
@@ -327,6 +327,7 @@ struct rte_security_docsis_xform {
 /**
  * Security session action type.
  */
+/* Enumeration of rte_security_session_action_type 8<*/
 enum rte_security_session_action_type {
 	RTE_SECURITY_ACTION_TYPE_NONE,
 	/**< No security actions */
@@ -347,8 +348,10 @@ enum rte_security_session_action_type {
 	 * protocol is processed synchronously by a CPU.
 	 */
 };
+/* >8 End enumeration of rte_security_session_action_type. */
 
 /** Security session protocol definition */
+/* Enumeration of rte_security_session_protocol 8<*/
 enum rte_security_session_protocol {
 	RTE_SECURITY_PROTOCOL_IPSEC = 1,
 	/**< IPsec Protocol */
@@ -359,10 +362,12 @@ enum rte_security_session_protocol {
 	RTE_SECURITY_PROTOCOL_DOCSIS,
 	/**< DOCSIS Protocol */
 };
+/* >8 End enumeration of rte_security_session_protocol. */
 
 /**
  * Security session configuration
  */
+/* Structure rte_security_session_conf 8< */
 struct rte_security_session_conf {
 	enum rte_security_session_action_type action_type;
 	/**< Type of action to be performed on the session */
@@ -381,6 +386,7 @@ struct rte_security_session_conf {
 	void *userdata;
 	/**< Application specific userdata to be saved with session */
 };
+/* >8 End of structure rte_security_session_conf. */
 
 struct rte_security_session {
 	void *sess_private_data;
-- 
2.39.2

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2023-10-19 00:28:57.249466041 +0100
+++ 0020-doc-replace-code-blocks-with-includes-in-security-gu.patch	2023-10-19 00:28:56.249805367 +0100
@@ -1 +1 @@
-From 03e3cfda1679998aa512464affb8dd293146364a Mon Sep 17 00:00:00 2001
+From 029efa33a077190d28c82d1984f1e58c47586566 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 03e3cfda1679998aa512464affb8dd293146364a ]
+
@@ -10 +11,0 @@
-Cc: stable@dpdk.org
@@ -16 +17 @@
- lib/security/rte_security.h            |  6 +++
+ lib/librte_security/rte_security.h     |  6 +++
@@ -20 +21 @@
-index 7418e35c1b..ae8b0aaef3 100644
+index f72bc8a78f..2939771b87 100644
@@ -23 +24 @@
-@@ -671,68 +671,27 @@ Security session configuration
+@@ -583,68 +583,27 @@ Security session configuration
@@ -46 +47 @@
-+.. literalinclude:: ../../../lib/security/rte_security.h
++.. literalinclude:: ../../../lib/librte_security/rte_security.h
@@ -78 +79 @@
-+.. literalinclude:: ../../../lib/security/rte_security.h
++.. literalinclude:: ../../../lib/librte_security/rte_security.h
@@ -97 +98 @@
-+.. literalinclude:: ../../../lib/security/rte_security.h
++.. literalinclude:: ../../../lib/librte_security/rte_security.h
@@ -104,5 +105,5 @@
-diff --git a/lib/security/rte_security.h b/lib/security/rte_security.h
-index 3f8abfef15..c6550f4d8d 100644
---- a/lib/security/rte_security.h
-+++ b/lib/security/rte_security.h
-@@ -622,6 +622,7 @@ struct rte_security_docsis_xform {
+diff --git a/lib/librte_security/rte_security.h b/lib/librte_security/rte_security.h
+index 88d31de0a6..42895411c3 100644
+--- a/lib/librte_security/rte_security.h
++++ b/lib/librte_security/rte_security.h
+@@ -327,6 +327,7 @@ struct rte_security_docsis_xform {
@@ -116 +117 @@
-@@ -642,8 +643,10 @@ enum rte_security_session_action_type {
+@@ -347,8 +348,10 @@ enum rte_security_session_action_type {
@@ -127 +128 @@
-@@ -654,10 +657,12 @@ enum rte_security_session_protocol {
+@@ -359,10 +362,12 @@ enum rte_security_session_protocol {
@@ -140 +141 @@
-@@ -675,6 +680,7 @@ struct rte_security_session_conf {
+@@ -381,6 +386,7 @@ struct rte_security_session_conf {
@@ -146,2 +147,2 @@
- /**
-  * Create security session as specified by the session configuration
+ struct rte_security_session {
+ 	void *sess_private_data;