From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: john.mcnamara@intel.com, Bruce Richardson <bruce.richardson@intel.com>
Subject: [PATCH v2 4/8] doc/linux_gsg: merge requirements section for app building
Date: Thu, 10 Mar 2022 12:38:39 +0000 [thread overview]
Message-ID: <20220310123843.612207-5-bruce.richardson@intel.com> (raw)
In-Reply-To: <20220310123843.612207-1-bruce.richardson@intel.com>
When building end-applications linked with DPDK, the only additional
tool needed is pkg-config/pkgconf. However, the standard development
tools meta-packages on most distro's include this as standard, meaning
it does not really require its own section. The one outlier in the
existing text is "alpine" where it is not present when using "libc-dev"
target. However, changing "gcc" and "libc-dev" to "alpine-sdk"
metapackage aligns alpine with the other distros in this regard.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
doc/guides/linux_gsg/sys_reqs.rst | 26 ++++++++++----------------
1 file changed, 10 insertions(+), 16 deletions(-)
diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst
index df367742cc..08d45898f0 100644
--- a/doc/guides/linux_gsg/sys_reqs.rst
+++ b/doc/guides/linux_gsg/sys_reqs.rst
@@ -27,11 +27,19 @@ Compilation of the DPDK
The setup commands and installed packages needed on various systems may be different.
For details on Linux distributions and the versions tested, please consult the DPDK Release Notes.
-* General development tools including a supported C compiler such as gcc (version 4.9+) or clang (version 3.4+).
+* General development tools including a supported C compiler such as gcc (version 4.9+) or clang (version 3.4+),
+ and ``pkg-config`` or ``pkgconf`` to be used when building end-user binaries against DPDK.
* For RHEL/Fedora systems these can be installed using ``dnf groupinstall "Development Tools"``
* For Ubuntu/Debian systems these can be installed using ``apt install build-essential``
- * For Alpine Linux, ``apk add gcc libc-dev bsd-compat-headers libexecinfo-dev``
+ * For Alpine Linux, ``apk add alpine-sdk bsd-compat-headers libexecinfo-dev``
+
+.. note::
+
+ pkg-config 0.27, supplied with RHEL-7,
+ does not process the Libs.private section correctly,
+ resulting in statically linked applications not being linked properly.
+ Use an updated version of ``pkg-config`` or ``pkgconf`` instead when building applications
* Python 3.5 or later.
@@ -87,20 +95,6 @@ For poll-mode drivers, the additional dependencies for each driver can be
found in that driver's documentation in the relevant DPDK guide document,
e.g. :doc:`../nics/index`
-
-Building DPDK Applications
---------------------------
-
-The tool pkg-config or pkgconf, integrated in most build systems,
-must be used to parse options and dependencies from libdpdk.pc.
-
-.. note::
-
- pkg-config 0.27, supplied with RHEL-7,
- does not process the Libs.private section correctly,
- resulting in statically linked applications not being linked properly.
-
-
Running DPDK Applications
-------------------------
--
2.32.0
next prev parent reply other threads:[~2022-03-10 12:39 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-08 14:49 [PATCH 0/5] Small Doc improvements for Linux GSG Bruce Richardson
2022-03-08 14:49 ` [PATCH 1/5] doc/linux_gsg: add driver guides to document list Bruce Richardson
2022-03-08 14:49 ` [PATCH 2/5] doc/linux_gsg: drop note about old chipset Bruce Richardson
2022-03-08 14:49 ` [PATCH 3/5] doc/linux_gsg: remove duplicated note Bruce Richardson
2022-03-08 14:50 ` [PATCH 4/5] doc/linux_gsg: merge requirements section for app building Bruce Richardson
2022-03-08 14:50 ` [PATCH 5/5] doc/linux_gsg: expand list of directories Bruce Richardson
2022-03-10 12:38 ` [PATCH v2 0/8] Linux GSG doc updates Bruce Richardson
2022-03-10 12:38 ` [PATCH v2 1/8] doc/linux_gsg: add driver guides to document list Bruce Richardson
2022-03-10 12:38 ` [PATCH v2 2/8] doc/linux_gsg: drop note about old chipset Bruce Richardson
2022-03-10 12:38 ` [PATCH v2 3/8] doc/linux_gsg: remove duplicated note Bruce Richardson
2022-03-10 12:38 ` Bruce Richardson [this message]
2022-03-10 12:38 ` [PATCH v2 5/8] doc/linux_gsg: expand list of directories Bruce Richardson
2022-03-10 12:38 ` [PATCH v2 6/8] doc/linux_gsg: shorten details on HPET use Bruce Richardson
2022-03-10 12:38 ` [PATCH v2 7/8] doc/linux_gsg: drop reference to KNI Bruce Richardson
2022-03-10 12:38 ` [PATCH v2 8/8] doc/linux_gsg: remove section on IOMMU pass-through Bruce Richardson
2022-03-15 18:46 ` [PATCH v2 0/8] Linux GSG doc updates Thomas Monjalon
2022-03-15 21:41 ` Bruce Richardson
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220310123843.612207-5-bruce.richardson@intel.com \
--to=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).