[v3,0/6] doc/qat: clarify build config options
mbox series

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

Message

Trahe, Fiona Aug. 10, 2018, 2:10 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.


v3 changes
 - squashed some patches
 - added more text to remaining commit msgs
 - fixed underline line length
 - fixed typo: comp_qat should be qat 

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 (6):
  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: update build instructions for both PMDs
  doc/qat: describe build config options

 doc/guides/compressdevs/qat_comp.rst |   6 +-
 doc/guides/cryptodevs/qat.rst        | 195 +++++++++++++++++++++++++----------
 2 files changed, 143 insertions(+), 58 deletions(-)

Comments

Tomasz Jozwiak Aug. 13, 2018, 2:51 p.m. UTC | #1
-----Original Message-----
From: Trahe, Fiona 
Sent: Friday, August 10, 2018 4:11 PM
To: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Jozwiak, TomaszX <tomaszx.jozwiak@intel.com>; thomas@monjalon.net
Cc: Trahe, Fiona <fiona.trahe@intel.com>
Subject: [PATCH v3 0/6] 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.


v3 changes
 - squashed some patches
 - added more text to remaining commit msgs
 - fixed underline line length
 - fixed typo: comp_qat should be qat 

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 (6):
  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: update build instructions for both PMDs
  doc/qat: describe build config options

 doc/guides/compressdevs/qat_comp.rst |   6 +-
 doc/guides/cryptodevs/qat.rst        | 195 +++++++++++++++++++++++++----------
 2 files changed, 143 insertions(+), 58 deletions(-)

--
2.13.6


Series-acked-by: tomaszx.jozwiak@intel.com
Akhil Goyal Aug. 23, 2018, 11:12 a.m. UTC | #2
On 8/10/2018 7:40 PM, Fiona Trahe wrote:

> Clarified documentation structure between
> compressedev, cryptodev and common build parts.
> Clarified build configuration options.
> Added Testing section.
> Fixed typos and made some cosmetic improvements.
>
>
> v3 changes
>   - squashed some patches
>   - added more text to remaining commit msgs
>   - fixed underline line length
>   - fixed typo: comp_qat should be qat
>
> 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 (6):
>    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: update build instructions for both PMDs
>    doc/qat: describe build config options
>
>   doc/guides/compressdevs/qat_comp.rst |   6 +-
>   doc/guides/cryptodevs/qat.rst        | 195 +++++++++++++++++++++++++----------
>   2 files changed, 143 insertions(+), 58 deletions(-)
>
>
Patchset applied to dpdk-next-crypto.

Subject for "doc/qat: fix typos and make cosmetic changes" changed to "doc/qat: correct typo and make cosmetic changes"

to avoid git log error.

Thanks,

Akhil
Thomas Monjalon Aug. 23, 2018, 11:24 a.m. UTC | #3
23/08/2018 13:12, Akhil Goyal:
> Patchset applied to dpdk-next-crypto.
> 
> Subject for "doc/qat: fix typos and make cosmetic changes" changed to "doc/qat: correct typo and make cosmetic changes"
> 
> to avoid git log error.

Which error? Lack of Fixes tag?
As a committer, you must be sure the Fixes tags and Cc: stable@dpdk.org
are all set. It is mandatory to know what should be backported and where.
Even typos should be backported.
Akhil Goyal Aug. 23, 2018, 11:28 a.m. UTC | #4
Hi Thomas,

On 8/23/2018 4:54 PM, Thomas Monjalon wrote:

> 23/08/2018 13:12, Akhil Goyal:
>> Patchset applied to dpdk-next-crypto.
>>
>> Subject for "doc/qat: fix typos and make cosmetic changes" changed to "doc/qat: correct typo and make cosmetic changes"
>>
>> to avoid git log error.
> Which error? Lack of Fixes tag?
> As a committer, you must be sure the Fixes tags and Cc: stable@dpdk.org
> are all set. It is mandatory to know what should be backported and where.
> Even typos should be backported.
>
>
Fiona clarified that this patch is not required for back porting.

Regards,

Akhil
Thomas Monjalon Aug. 23, 2018, 11:35 a.m. UTC | #5
23/08/2018 13:28, Akhil Goyal:
> Hi Thomas,
> 
> On 8/23/2018 4:54 PM, Thomas Monjalon wrote:
> 
> > 23/08/2018 13:12, Akhil Goyal:
> >> Patchset applied to dpdk-next-crypto.
> >>
> >> Subject for "doc/qat: fix typos and make cosmetic changes" changed to "doc/qat: correct typo and make cosmetic changes"
> >>
> >> to avoid git log error.
> > Which error? Lack of Fixes tag?
> > As a committer, you must be sure the Fixes tags and Cc: stable@dpdk.org
> > are all set. It is mandatory to know what should be backported and where.
> > Even typos should be backported.
> >
> >
> Fiona clarified that this patch is not required for back porting.

It will make future backporting of doc fixes harder.
That's a good example to discuss.
OK to keep it as is, and will discuss it with maintainers of stable branches
during the Dublin event, in order to make the policies clear.