[dpdk-dev] [PATCH 6/6] doc: add documentation for OCTEON TX2 crypto asym support

Akhil Goyal akhil.goyal at nxp.com
Tue Sep 10 13:39:45 CEST 2019


Hi Anoob,

> 
> Hi Thomas,
> 
> Please see inline.
> 
> Thanks,
> Anoob
> 
> > -----Original Message-----
> > From: Thomas Monjalon <thomas at monjalon.net>
> > Sent: Tuesday, September 10, 2019 12:00 PM
> > To: Jerin Jacob Kollanukkaran <jerinj at marvell.com>; Anoob Joseph
> > <anoobj at marvell.com>
> > Cc: Akhil Goyal <akhil.goyal at nxp.com>; Pablo de Lara
> > <pablo.de.lara.guarch at intel.com>; Narayana Prasad Raju Athreya
> > <pathreya at marvell.com>; Fiona Trahe <fiona.trahe at intel.com>; Kanaka
> > Durga Kotamarthy <kkotamarthy at marvell.com>; Shally Verma
> > <shallyv at marvell.com>; Sunila Sahu <ssahu at marvell.com>; dev at 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 at marvell.com>
> > > > Adding documentation for asymmetric features supported by
> > > > crypto_octeontx2 PMD.
> > > >
> > > > Signed-off-by: Anoob Joseph <anoobj at marvell.com>
> > > > Signed-off-by: Kanaka Durga Kotamarthy <kkotamarthy at marvell.com>
> > > > Signed-off-by: Sunila Sahu <ssahu at 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


More information about the dev mailing list