[dpdk-dev] [PATCH v2] doc: add pmdinfogen rewrite to release notes

[Kevin Traynor]

On 12/02/2021 14:29, Bruce Richardson wrote:
> On Fri, Feb 12, 2021 at 03:17:39PM +0100, Thomas Monjalon wrote:
>> From: Dmitry Kozlyuk <dmitry.kozliuk at gmail.com>
>>
>> The build tool pmdinfogen was rewritten in DPDK 21.02,
>> adding Windows support.
>> There is a new build-time dependency: pyelftools.
>>
>> Fixes: f0f93a7adfee ("buildtools: use Python pmdinfogen")
>> Fixes: 6b19edcb663c ("build: enable pmdinfogen for Windows")
>>
>> Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk at gmail.com>
>> Signed-off-by: Thomas Monjalon <thomas at monjalon.net>
> 
> Acked-by: Bruce Richardson <bruce.richardson at intel.com>
> 
> One additional suggestion below if you want to take it too.
> 
>> ---
>>  doc/guides/rel_notes/release_21_02.rst | 13 +++++++++++++
>>  1 file changed, 13 insertions(+)
>>
>> diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst
>> index 64e220f2ac..99a559479b 100644
>> --- a/doc/guides/rel_notes/release_21_02.rst
>> +++ b/doc/guides/rel_notes/release_21_02.rst
>> @@ -20,6 +20,12 @@ DPDK Release 21.02
>>        make doc-guides-html
>>        xdg-open build/doc/html/guides/rel_notes/release_21_02.html
>>  
>> +.. note::
>> +
>> +   A dependency has been added for building DPDK on Linux or FreeBSD:
>> +   the Python module pyelftools (version 0.22 or greater),
>> +   often packaged as python3-pyelftools, is required.
> This module can also be installed using pip for python3 e.g.
> "pip3 install pyelftools".
> 

yep, just about to send a doc patch for that.

>> +
>>  
>>  New Features
>>  ------------
>> @@ -180,6 +186,13 @@ New Features
>>    tests and output graphed results to PDF files.
>>    See the :doc:`../tools/cryptoperf` guide for more details.
>>  
>> +* **Added Windows support to pmdinfogen.**
>> +
>> +  PMD information strings were added for Windows as well as for other OS.
>> +  Extracting them from Windows DLL is not yet supported.
>> +  The build-time tool pmdinfogen was rewritten in Python,
>> +  thus libelf dependency was replaced with pyelftools as new build dependency.
>> +
>>  * **Added support for build-time checking of header includes.**
>>  
>>    A new build option ``check_includes`` has been added, which, when enabled,
>> -- 
>> 2.30.0
>>
>