[v3] doc: add pmdinfogen rewrite to release notes

Message ID 20210212151527.1122082-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v3] doc: add pmdinfogen rewrite to release notes |

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/travis-robot fail travis build: failed
ci/checkpatch success coding style OK

Commit Message

Thomas Monjalon Feb. 12, 2021, 3:15 p.m. UTC
  From: Dmitry Kozlyuk <dmitry.kozliuk@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@gmail.com>
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/rel_notes/release_21_02.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
  

Comments

Thomas Monjalon Feb. 14, 2021, 9:53 a.m. UTC | #1
12/02/2021 16:15, Thomas Monjalon:
> From: Dmitry Kozlyuk <dmitry.kozliuk@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@gmail.com>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied
  

Patch

diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst
index 64e220f2ac..743f1505ef 100644
--- a/doc/guides/rel_notes/release_21_02.rst
+++ b/doc/guides/rel_notes/release_21_02.rst
@@ -20,6 +20,16 @@  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.
+
+   If not available as a distribution package, it can be installed with::
+
+      pip3 install pyelftools
+
 
 New Features
 ------------
@@ -180,6 +190,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,