From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id A2D20427F9; Tue, 21 Mar 2023 17:08:33 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 7FDAD40A7F; Tue, 21 Mar 2023 17:08:33 +0100 (CET) Received: from wout5-smtp.messagingengine.com (wout5-smtp.messagingengine.com [64.147.123.21]) by mails.dpdk.org (Postfix) with ESMTP id 5E53A40A7A; Tue, 21 Mar 2023 17:08:32 +0100 (CET) Received: from compute6.internal (compute6.nyi.internal [10.202.2.47]) by mailout.west.internal (Postfix) with ESMTP id C43A1320093F; Tue, 21 Mar 2023 12:08:27 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute6.internal (MEProxy); Tue, 21 Mar 2023 12:08:29 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:cc:content-transfer-encoding:content-type:content-type:date :date:from:from:in-reply-to:in-reply-to:message-id:mime-version :references:reply-to:sender:subject:subject:to:to; s=fm2; t= 1679414907; x=1679501307; bh=KETeL+nrgt8A0tb7vKpd9tmRIkU14k6oUpG xMY2TjtU=; b=cHDsiw9n7ymgp0PngO7vjqA0gd88Z7yzUbrxQs5urndt+Pi8emN JiGSrh4WEK+kkzvqtBFYMpO9Chxsnz8ANCoHpRr/TjMuANhF/zrX4RQIWNjbuk7a eKggYjFiwY68eQWTb1VTrObbtbyQ2y1r8OBHHhfvA78lR7okZWU2IOwNhui4oF3+ HUQ6uQM3GvewO2omM5/aqeuScDZ+lJUnT+N5l2ZparD20ipVzZaTZys0swZmC2mU JWVkl3C8eNcvHHbIjPrPGwQRnq5LI5/U0ynU7Dkodcqg0R9Z+0iIumNFFJTzJ8A8 jgs5d3hhHphrhj+QQxYP02zVH3WfN/5e9MQ== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:content-type:date:date:feedback-id:feedback-id :from:from:in-reply-to:in-reply-to:message-id:mime-version :references:reply-to:sender:subject:subject:to:to:x-me-proxy :x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s=fm2; t= 1679414907; x=1679501307; bh=KETeL+nrgt8A0tb7vKpd9tmRIkU14k6oUpG xMY2TjtU=; b=k9nT0vhnSmMQUVNhNIVUYBPd8E2mZHQD5QRogcFzurW4NmdGLGU NejiLngtjy0CA+rdvhQpxxVxZafyXa4HvIuvjzHdFGD7+SHUm2saVPwZM01LR8ad u9WG/FL2JBFTMxBxTC3ruZ5fcpkhcffZKpqKAkpLbJXwfy9L7rJ3LAJ+FTZ1VPoY ADqbUxvmVlHutt/8z+kNBTcQQdreVWgGrj8bXLkjveLRtAgLyq5VpvZaYLswldNb PzfbSE1poYv8t/j3iqTmocoy5Ac7GekDle8TIR2MjyOP4I3NmQqtIG88oP6JHVrP vzTrmhp45LN0wpSJBasspHq5wU69LsZqJxQ== X-ME-Sender: <xms:etYZZMoG_fw9uhsh7lRwrQv7WJqDtxajOnBC1zLArErsMXa7xD8XFA> <xme:etYZZCp8A8K4OCM2mUd4_ao9oKlVrsEMMOh0w2_kF-nqTCT1nwTOyDjqJbExpAlpD 7C17I7wBwUoa9nP-w> X-ME-Received: <xmr:etYZZBPyIZdwP-7tZ18tl3g6k9KkLNVLlE5EXkMcSB81gp_1bPx7Fgm7_1DXZpveISnfwZmMcVIbanPISXw_87i-sA> X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvhedrvdegtddgkeegucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvvefufffkjghfggfgtgesthfuredttddtvdenucfhrhhomhepvfhhohhm rghsucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenuc ggtffrrghtthgvrhhnpedtjeeiieefhedtfffgvdelteeufeefheeujefgueetfedttdei kefgkeduhedtgfenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfh hrohhmpehthhhomhgrshesmhhonhhjrghlohhnrdhnvght X-ME-Proxy: <xmx:etYZZD6QWMGNwhBAV5ko6Vwcc2aKjGQCdmd1sMDyQuSOn9kKtzja3g> <xmx:etYZZL7iuN29xc5wxM4M23GlV4lPoijkKITXjL7cl8FpXfEfIHPT0w> <xmx:etYZZDjbfc8BNEg55qTRJeR2vMHt1Qt87Ekf8pAWGmGbWj8hBmCoWw> <xmx:e9YZZFuERp-4wfH7-ADyPhrOmDNZw3_YBeJ_in3tCydFoxFzT2o0mg> Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Tue, 21 Mar 2023 12:08:23 -0400 (EDT) From: Thomas Monjalon <thomas@monjalon.net> To: Akhil Goyal <gakhil@marvell.com> Cc: "dev@dpdk.org" <dev@dpdk.org>, "david.marchand@redhat.com" <david.marchand@redhat.com>, "hemant.agrawal@nxp.com" <hemant.agrawal@nxp.com>, Anoob Joseph <anoobj@marvell.com>, "pablo.de.lara.guarch@intel.com" <pablo.de.lara.guarch@intel.com>, "fiona.trahe@intel.com" <fiona.trahe@intel.com>, "declan.doherty@intel.com" <declan.doherty@intel.com>, "matan@nvidia.com" <matan@nvidia.com>, "g.singh@nxp.com" <g.singh@nxp.com>, "fanzhang.oss@gmail.com" <fanzhang.oss@gmail.com>, "jianjay.zhou@huawei.com" <jianjay.zhou@huawei.com>, "asomalap@amd.com" <asomalap@amd.com>, "ruifeng.wang@arm.com" <ruifeng.wang@arm.com>, "konstantin.v.ananyev@yandex.ru" <konstantin.v.ananyev@yandex.ru>, "radu.nicolau@intel.com" <radu.nicolau@intel.com>, "ajit.khaparde@broadcom.com" <ajit.khaparde@broadcom.com>, Nagadheeraj Rottela <rnagadheeraj@marvell.com>, Ankur Dwivedi <adwivedi@marvell.com>, "ciara.power@intel.com" <ciara.power@intel.com>, "stable@dpdk.org" <stable@dpdk.org> Subject: Re: [EXT] Re: [PATCH] doc: fix cryptodev code block mismatch Date: Tue, 21 Mar 2023 17:08:22 +0100 Message-ID: <2593261.tIAgqjz4sF@thomas> In-Reply-To: <CO6PR18MB4484B353B9FF5E2B9C404F2FD8819@CO6PR18MB4484.namprd18.prod.outlook.com> References: <20230321130527.3182636-1-gakhil@marvell.com> <10836476.5MRjnR8RnV@thomas> <CO6PR18MB4484B353B9FF5E2B9C404F2FD8819@CO6PR18MB4484.namprd18.prod.outlook.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" 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>, <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>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org 21/03/2023 15:57, Akhil Goyal: > > 21/03/2023 14:05, Akhil Goyal: > > > Certain structures were replicated in programmer's guide, > > > which resulted in mismatch when that structure is changed > > > in future releases. > > > Added literal includes to copy code block while compiling. > > > > The best is to avoid including code in docs. > > Why do we need these structures in the guide? > > > These are not complete code, only the structure defines > Which helps in understanding the fields and flow of APIs. I'm not opposed, but in general I think it is better to explain the global design and usage flow in the guides. The detailed API is explained in the doxygen comments. With that said, you are the maintainer, so we rely on your choices :)