doc/rel_notes: add note on libarchive dependencies

Message ID 20231109105204.12944-1-bruce.richardson@intel.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers
Series doc/rel_notes: add note on libarchive dependencies |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/github-robot: build success github build: passed
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional fail Functional issues

Commit Message

Bruce Richardson Nov. 9, 2023, 10:52 a.m. UTC
  Since DPDK now registers an explicit dependency on libarchive, rather
than just putting -larchive in link args, we need to add a documentation
note about potential missing dependencies when static linking.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/rel_notes/release_23_11.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)
  

Comments

David Marchand Nov. 24, 2023, 1:50 p.m. UTC | #1
On Thu, Nov 9, 2023 at 11:52 AM Bruce Richardson
<bruce.richardson@intel.com> wrote:
>
> Since DPDK now registers an explicit dependency on libarchive, rather
> than just putting -larchive in link args, we need to add a documentation
> note about potential missing dependencies when static linking.
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>

Reviewed-by: David Marchand <david.marchand@redhat.com>

Applied, thanks.
  

Patch

diff --git a/doc/guides/rel_notes/release_23_11.rst b/doc/guides/rel_notes/release_23_11.rst
index ff28083e1c..0b33665868 100644
--- a/doc/guides/rel_notes/release_23_11.rst
+++ b/doc/guides/rel_notes/release_23_11.rst
@@ -75,6 +75,16 @@  New Features
     which also added support for standard atomics
     (Ref: https://releases.llvm.org/3.6.0/tools/clang/docs/ReleaseNotes.html)
 
+* **Extra dependencies when linking against libarchive**
+
+  When the libarchive development package is present on the system,
+  DPDK will use libarchive and register a dependency on it.
+  However, on a number of Linux distributions, including, for example, Fedora and Ubuntu,
+  installing the libarchive dev package does not cause all required dependencies for static linking to be automatically installed too.
+  These additional dev packages, such as ``liblz4-dev`` and ``libacl1-dev`` on Ubuntu,
+  will need to be installed manually (if not already present)
+  to prevent errors with linking against DPDK static libraries.
+
 * **Added new build options.**
 
   * Enabling deprecated libraries is now done using