DPDK patches and discussions
 help / color / Atom feed
From: Akhil Goyal <akhil.goyal@nxp.com>
To: Anoob Joseph <anoobj@marvell.com>,
	Thomas Monjalon <thomas@monjalon.net>,
	 Jerin Jacob Kollanukkaran <jerinj@marvell.com>
Cc: Pablo de Lara <pablo.de.lara.guarch@intel.com>,
	Narayana Prasad Raju Athreya <pathreya@marvell.com>,
	Fiona Trahe <fiona.trahe@intel.com>,
	Kanaka Durga Kotamarthy <kkotamarthy@marvell.com>,
	Shally Verma <shallyv@marvell.com>,
	Sunila Sahu <ssahu@marvell.com>, "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH 6/6] doc: add documentation for OCTEON TX2 crypto asym support
Date: Tue, 10 Sep 2019 11:39:45 +0000
Message-ID: <VE1PR04MB6639DF6F655BEBE9ADC1D9C6E6B60@VE1PR04MB6639.eurprd04.prod.outlook.com> (raw)
In-Reply-To: <MN2PR18MB2877C8CBC4F94B7E760B1B8CDFB60@MN2PR18MB2877.namprd18.prod.outlook.com>

Hi Anoob,

> 
> Hi Thomas,
> 
> Please see inline.
> 
> Thanks,
> Anoob
> 
> > -----Original Message-----
> > From: Thomas Monjalon <thomas@monjalon.net>
> > Sent: Tuesday, September 10, 2019 12:00 PM
> > To: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; Anoob Joseph
> > <anoobj@marvell.com>
> > Cc: Akhil Goyal <akhil.goyal@nxp.com>; Pablo de Lara
> > <pablo.de.lara.guarch@intel.com>; Narayana Prasad Raju Athreya
> > <pathreya@marvell.com>; Fiona Trahe <fiona.trahe@intel.com>; Kanaka
> > Durga Kotamarthy <kkotamarthy@marvell.com>; Shally Verma
> > <shallyv@marvell.com>; Sunila Sahu <ssahu@marvell.com>; dev@dpdk.org
> > Subject: Re: [PATCH 6/6] doc: add documentation for OCTEON TX2 crypto
> > asym support
> >
> > 10/09/2019 06:13, Jerin Jacob Kollanukkaran:
> > > From: Anoob Joseph <anoobj@marvell.com>
> > > > Adding documentation for asymmetric features supported by
> > > > crypto_octeontx2 PMD.
> > > >
> > > > Signed-off-by: Anoob Joseph <anoobj@marvell.com>
> > > > Signed-off-by: Kanaka Durga Kotamarthy <kkotamarthy@marvell.com>
> > > > Signed-off-by: Sunila Sahu <ssahu@marvell.com>
> > > > ---
> > > >  doc/guides/cryptodevs/features/octeontx2.ini |  9 +++++++++
> > > >  doc/guides/cryptodevs/octeontx2.rst          | 13 +++++++++++++
> > >
> > > Please update the release notes.
> >
> > Please avoid doing a separate patch for documentation.
> > It could be updated while adding the feature, in the same patch.
> 
> [Anoob] To which patch should I squash this change? Here are my options,
> 
> 1. The patch which adds ASYM in capabilities. Issue: the doc update updates
> about autotest, which won't be available until the final patch is merged.
> 2. Test patch which adds the autotest for the PMD. Issue: Additions to the doc
> would be done by a patch which adds test.
> 
> Which one should I use?

As per the convention followed these days, documentation should be the part of the
Patch which support it.
If you have supported many features in your patchset, you should add that piece
of documentation which is supported in each of the patches in the patchset.

Release notes should be added in the patch which completes the whole feature.

-Akhil

  reply index

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-09 15:26 [dpdk-dev] [PATCH 0/6] add asymmetric support in crypto_octeontx2 PMD Anoob Joseph
2019-09-09 15:26 ` [dpdk-dev] [PATCH 1/6] crypto/octeontx2: add RSA and modexp asym capabilities Anoob Joseph
2019-09-09 15:26 ` [dpdk-dev] [PATCH 2/6] crypto/octeontx2: allocate memory for asymmetric operation Anoob Joseph
2019-09-09 15:26 ` [dpdk-dev] [PATCH 3/6] crypto/octeontx2: add asymmetric session operations Anoob Joseph
2019-09-09 15:26 ` [dpdk-dev] [PATCH 4/6] crypto/octeontx2: add asymmetric in enqueue/dequeue ops Anoob Joseph
2019-10-01 14:11   ` Akhil Goyal
2019-10-02 10:55     ` Anoob Joseph
2019-09-09 15:26 ` [dpdk-dev] [PATCH 5/6] app/test: register octeontx2 PMD to asym testsuite Anoob Joseph
2019-10-01 14:13   ` Akhil Goyal
2019-10-02 10:52     ` Anoob Joseph
2019-09-09 15:26 ` [dpdk-dev] [PATCH 6/6] doc: add documentation for OCTEON TX2 crypto asym support Anoob Joseph
2019-09-10  4:13   ` Jerin Jacob Kollanukkaran
2019-09-10  6:12     ` Anoob Joseph
2019-09-10  6:30     ` Thomas Monjalon
2019-09-10 11:33       ` Anoob Joseph
2019-09-10 11:39         ` Akhil Goyal [this message]
2019-09-10 12:23           ` Anoob Joseph
2019-09-10 11:41         ` Thomas Monjalon
2019-09-09 16:25 ` [dpdk-dev] [PATCH 0/6] add asymmetric support in crypto_octeontx2 PMD Shally Verma

Reply instructions:

You may reply publically 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=VE1PR04MB6639DF6F655BEBE9ADC1D9C6E6B60@VE1PR04MB6639.eurprd04.prod.outlook.com \
    --to=akhil.goyal@nxp.com \
    --cc=anoobj@marvell.com \
    --cc=dev@dpdk.org \
    --cc=fiona.trahe@intel.com \
    --cc=jerinj@marvell.com \
    --cc=kkotamarthy@marvell.com \
    --cc=pablo.de.lara.guarch@intel.com \
    --cc=pathreya@marvell.com \
    --cc=shallyv@marvell.com \
    --cc=ssahu@marvell.com \
    --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

DPDK patches and discussions

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ http://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/ public-inbox