[v2,0/8] doc/qat: clarify build config options
mbox series

Message ID 1533833430-29134-1-git-send-email-fiona.trahe@intel.com
Headers show
Series
  • doc/qat: clarify build config options
Related show

Message

Trahe, Fiona Aug. 9, 2018, 4:50 p.m. UTC
Clarified documentation structure between
compressedev, cryptodev and common build parts.
Clarified build configuration options.
Added Testing section.
Fixed typos and made some cosmetic improvements.

v2 changes
 - split into patchset
 - changed test path from build/build/test/test to build/app
 - use make defconfig instead of make config T=xxx
 - matched underline lengths to titles

Fiona Trahe (8):
  doc/qat: add limitations to compressdev PMD
  doc/qat: add information on how to test
  doc/qat: fix typos and make cosmetic changes
  doc/qat: add overview of doc sections
  doc/qat: remove unnecessary text
  doc/qat: update kernel dependency section
  doc/qat: update PMD build section
  doc/qat: describe build config options

 doc/guides/compressdevs/qat_comp.rst |   6 +-
 doc/guides/cryptodevs/qat.rst        | 197 ++++++++++++++++++++++++-----------
 2 files changed, 141 insertions(+), 62 deletions(-)

Comments

Pablo de Lara Aug. 9, 2018, 5:08 p.m. UTC | #1
> -----Original Message-----
> From: Trahe, Fiona
> Sent: Thursday, August 9, 2018 5:50 PM
> To: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>;
> Jozwiak, TomaszX <tomaszx.jozwiak@intel.com>
> Cc: Trahe, Fiona <fiona.trahe@intel.com>
> Subject: [PATCH v2 0/8] doc/qat: clarify build config options
> 
> Clarified documentation structure between compressedev, cryptodev and
> common build parts.
> Clarified build configuration options.
> Added Testing section.
> Fixed typos and made some cosmetic improvements.
> 
> v2 changes
>  - split into patchset
>  - changed test path from build/build/test/test to build/app
>  - use make defconfig instead of make config T=xxx
>  - matched underline lengths to titles
> 
> Fiona Trahe (8):
>   doc/qat: add limitations to compressdev PMD
>   doc/qat: add information on how to test
>   doc/qat: fix typos and make cosmetic changes
>   doc/qat: add overview of doc sections
>   doc/qat: remove unnecessary text
>   doc/qat: update kernel dependency section
>   doc/qat: update PMD build section
>   doc/qat: describe build config options
> 
>  doc/guides/compressdevs/qat_comp.rst |   6 +-
>  doc/guides/cryptodevs/qat.rst        | 197 ++++++++++++++++++++++++-----------
>  2 files changed, 141 insertions(+), 62 deletions(-)
> 
> --
> 2.13.6

Nice splitting :) Just a note on patch 8, which shows as  [Patch v2] doc/qat: describe build config options.

Apart from that:

Series-acked-by: Pablo de Lara <Pablo.de.lara.guarch@intel.com>
Thomas Monjalon Aug. 9, 2018, 7:49 p.m. UTC | #2
09/08/2018 18:50, Fiona Trahe:
> Clarified documentation structure between
> compressedev, cryptodev and common build parts.
> Clarified build configuration options.
> Added Testing section.
> Fixed typos and made some cosmetic improvements.
> 
> v2 changes
>  - split into patchset

I am not sure about the split.
Usually, when there is no text in the commit log,
it is a tip that it is not worth to be a separate commit.
Perhaps, it is good to have this split, but in this case,
please try to explain the purpose (or reason) of each patch in the commit logs.

Thanks
Trahe, Fiona Aug. 10, 2018, 7:57 a.m. UTC | #3
Hi Thomas

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Thursday, August 9, 2018 8:49 PM
> To: Trahe, Fiona <fiona.trahe@intel.com>
> Cc: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Jozwiak, TomaszX
> <tomaszx.jozwiak@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v2 0/8] doc/qat: clarify build config options
> 
> 09/08/2018 18:50, Fiona Trahe:
> > Clarified documentation structure between
> > compressedev, cryptodev and common build parts.
> > Clarified build configuration options.
> > Added Testing section.
> > Fixed typos and made some cosmetic improvements.
> >
> > v2 changes
> >  - split into patchset
> 
> I am not sure about the split.
> Usually, when there is no text in the commit log,
> it is a tip that it is not worth to be a separate commit.
> Perhaps, it is good to have this split, but in this case,
> please try to explain the purpose (or reason) of each patch in the commit logs.
> 
> Thanks
> 
With over 200 changed lines in the v1 patch I did this to make it easier for Pablo to review.
I'll add more explanation in the v3.