DPDK patches and discussions
 help / color / mirror / Atom feed
From: Akhil Goyal <gakhil@marvell.com>
To: Thomas Monjalon <thomas@monjalon.net>
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: Fri, 24 Mar 2023 17:53:34 +0000	[thread overview]
Message-ID: <CO6PR18MB4484319E74E2455E15C1702DD8849@CO6PR18MB4484.namprd18.prod.outlook.com> (raw)
In-Reply-To: <2593261.tIAgqjz4sF@thomas>

> Subject: Re: [EXT] Re: [PATCH] doc: fix cryptodev code block mismatch
> 
> 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.

Agreed with your point, and I do feel some of these can be removed.
But there is mismatch in the structs along past releases.
I thought of fixing this in stable releases, and we can remove whichever 
Not required in future release.

> 
> With that said, you are the maintainer, so we rely on your choices :)
> 
Thank you for your trust.
Moreover, I am always open for suggestions and improvements.

  reply	other threads:[~2023-03-24 17:53 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-21 13:05 Akhil Goyal
2023-03-21 14:50 ` Thomas Monjalon
2023-03-21 14:57   ` [EXT] " Akhil Goyal
2023-03-21 16:08     ` Thomas Monjalon
2023-03-24 17:53       ` Akhil Goyal [this message]
2023-03-27  8:21 ` Power, Ciara
2023-03-27  9:51   ` Hemant Agrawal
2023-03-28  6:39     ` Akhil Goyal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CO6PR18MB4484319E74E2455E15C1702DD8849@CO6PR18MB4484.namprd18.prod.outlook.com \
    --to=gakhil@marvell.com \
    --cc=adwivedi@marvell.com \
    --cc=ajit.khaparde@broadcom.com \
    --cc=anoobj@marvell.com \
    --cc=asomalap@amd.com \
    --cc=ciara.power@intel.com \
    --cc=david.marchand@redhat.com \
    --cc=declan.doherty@intel.com \
    --cc=dev@dpdk.org \
    --cc=fanzhang.oss@gmail.com \
    --cc=fiona.trahe@intel.com \
    --cc=g.singh@nxp.com \
    --cc=hemant.agrawal@nxp.com \
    --cc=jianjay.zhou@huawei.com \
    --cc=konstantin.v.ananyev@yandex.ru \
    --cc=matan@nvidia.com \
    --cc=pablo.de.lara.guarch@intel.com \
    --cc=radu.nicolau@intel.com \
    --cc=rnagadheeraj@marvell.com \
    --cc=ruifeng.wang@arm.com \
    --cc=stable@dpdk.org \
    --cc=thomas@monjalon.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).