[3/3] doc: update release notes for Broadcom PMD

Message ID 20191119185638.78740-4-ajit.khaparde@broadcom.com (mailing list archive)
State Superseded, archived
Delegated to: Ajit Khaparde
Headers
Series bnxt patches |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/travis-robot success Travis build: passed
ci/Intel-compilation fail Compilation issues

Commit Message

Ajit Khaparde Nov. 19, 2019, 6:56 p.m. UTC
  Update release doc briefly describing updates to bnxt PMD for
19.11 release.

Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
---
 doc/guides/rel_notes/release_19_11.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)
  

Comments

Ferruh Yigit Nov. 20, 2019, 9:34 a.m. UTC | #1
On 11/19/2019 6:56 PM, Ajit Khaparde wrote:
> Update release doc briefly describing updates to bnxt PMD for
> 19.11 release.
> 
> Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> ---
>  doc/guides/rel_notes/release_19_11.rst | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/release_19_11.rst b/doc/guides/rel_notes/release_19_11.rst
> index 21be600ab..5d70e213e 100644
> --- a/doc/guides/rel_notes/release_19_11.rst
> +++ b/doc/guides/rel_notes/release_19_11.rst
> @@ -201,6 +201,16 @@ New Features
>    * Enabled zero copy between application mempools and UMEM by enabling the
>      XDP_UMEM_UNALIGNED_CHUNKS UMEM flag.
>  
> +* **Updated Broadcom bnxt driver.**
> +
> +  Updated Broadcom bnxt driver with new features and improvements, including:
> +
> +  * Added support for hot firmware upgrade.
> +  * Added support for error recovery.
> +  * Added support for querying and using COS classification in hardware.
> +  * Added LRO support Thor devices.
> +  * Update HWRM API to version 1.10.1.6
> +

Hi Ajit,

For next time, it is better to do the release notes / doc update in the patch
that adds the feature, that helps documenting features better.

Thanks,
ferruh
  
Ferruh Yigit Nov. 20, 2019, 9:45 a.m. UTC | #2
On 11/20/2019 9:34 AM, Ferruh Yigit wrote:
> On 11/19/2019 6:56 PM, Ajit Khaparde wrote:
>> Update release doc briefly describing updates to bnxt PMD for
>> 19.11 release.
>>
>> Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
>> ---
>>  doc/guides/rel_notes/release_19_11.rst | 10 ++++++++++
>>  1 file changed, 10 insertions(+)
>>
>> diff --git a/doc/guides/rel_notes/release_19_11.rst b/doc/guides/rel_notes/release_19_11.rst
>> index 21be600ab..5d70e213e 100644
>> --- a/doc/guides/rel_notes/release_19_11.rst
>> +++ b/doc/guides/rel_notes/release_19_11.rst
>> @@ -201,6 +201,16 @@ New Features
>>    * Enabled zero copy between application mempools and UMEM by enabling the
>>      XDP_UMEM_UNALIGNED_CHUNKS UMEM flag.
>>  
>> +* **Updated Broadcom bnxt driver.**
>> +
>> +  Updated Broadcom bnxt driver with new features and improvements, including:
>> +
>> +  * Added support for hot firmware upgrade.
>> +  * Added support for error recovery.
>> +  * Added support for querying and using COS classification in hardware.
>> +  * Added LRO support Thor devices.
>> +  * Update HWRM API to version 1.10.1.6
>> +
> 
> Hi Ajit,
> 
> For next time, it is better to do the release notes / doc update in the patch
> that adds the feature, that helps documenting features better.
> 

Indeed, similar to .ini file change request, can you please add commits ids
adding these features to the commit log as back reference? I am dropping this
patch while merging for now.
  
Ajit Khaparde Nov. 20, 2019, 4:55 p.m. UTC | #3
On Wed, Nov 20, 2019 at 1:45 AM Ferruh Yigit <ferruh.yigit@intel.com> wrote:

> On 11/20/2019 9:34 AM, Ferruh Yigit wrote:
> > On 11/19/2019 6:56 PM, Ajit Khaparde wrote:
> >> Update release doc briefly describing updates to bnxt PMD for
> >> 19.11 release.
> >>
> >> Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> >> ---
> >>  doc/guides/rel_notes/release_19_11.rst | 10 ++++++++++
> >>  1 file changed, 10 insertions(+)
> >>
> >> diff --git a/doc/guides/rel_notes/release_19_11.rst
> b/doc/guides/rel_notes/release_19_11.rst
> >> index 21be600ab..5d70e213e 100644
> >> --- a/doc/guides/rel_notes/release_19_11.rst
> >> +++ b/doc/guides/rel_notes/release_19_11.rst
> >> @@ -201,6 +201,16 @@ New Features
> >>    * Enabled zero copy between application mempools and UMEM by
> enabling the
> >>      XDP_UMEM_UNALIGNED_CHUNKS UMEM flag.
> >>
> >> +* **Updated Broadcom bnxt driver.**
> >> +
> >> +  Updated Broadcom bnxt driver with new features and improvements,
> including:
> >> +
> >> +  * Added support for hot firmware upgrade.
> >> +  * Added support for error recovery.
> >> +  * Added support for querying and using COS classification in
> hardware.
> >> +  * Added LRO support Thor devices.
> >> +  * Update HWRM API to version 1.10.1.6
> >> +
> >
> > Hi Ajit,
> >
> > For next time, it is better to do the release notes / doc update in the
> patch
> > that adds the feature, that helps documenting features better.
> >
>
> Indeed, similar to .ini file change request, can you please add commits ids
> adding these features to the commit log as back reference? I am dropping
> this
> patch while merging for now.
>
Will do. Thanks
  

Patch

diff --git a/doc/guides/rel_notes/release_19_11.rst b/doc/guides/rel_notes/release_19_11.rst
index 21be600ab..5d70e213e 100644
--- a/doc/guides/rel_notes/release_19_11.rst
+++ b/doc/guides/rel_notes/release_19_11.rst
@@ -201,6 +201,16 @@  New Features
   * Enabled zero copy between application mempools and UMEM by enabling the
     XDP_UMEM_UNALIGNED_CHUNKS UMEM flag.
 
+* **Updated Broadcom bnxt driver.**
+
+  Updated Broadcom bnxt driver with new features and improvements, including:
+
+  * Added support for hot firmware upgrade.
+  * Added support for error recovery.
+  * Added support for querying and using COS classification in hardware.
+  * Added LRO support Thor devices.
+  * Update HWRM API to version 1.10.1.6
+
 * **Added Marvell NITROX symmetric crypto PMD.**
 
   Added a symmetric crypto PMD for Marvell NITROX V security processor.