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

[Thomas Monjalon]

10/09/2019 13:33, Anoob Joseph:
> From: Thomas Monjalon <thomas at monjalon.net>
> > 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?

You should split the doc patch and squash in both relevant patches.
This is exactly why I prefer to have doc squashed:
When I will look at the autotest patch, I will find the doc for this test.
Same for the feature patch.
It is also better for git history: if you git blame on doc, you will find
the commit implementing what is documented.

Thanks