From: Jihan LIN via B4 Relay <devnull+linjh22s.gmail.com@kernel.org>
To: Nathan Chancellor <nathan@kernel.org>,
Nicolas Schier <nsc@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Miguel Ojeda <ojeda@kernel.org>,
Boqun Feng <boqun.feng@gmail.com>,
Sami Tolvanen <samitolvanen@google.com>,
Masahiro Yamada <masahiroy@kernel.org>,
Petr Pavlu <petr.pavlu@suse.com>
Cc: linux-modules@vger.kernel.org, linux-kbuild@vger.kernel.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Jihan LIN <linjh22s@gmail.com>
Subject: [PATCH v2 1/2] Documentation/kbuild: Document gendwarfksyms build dependencies
Date: Wed, 14 Jan 2026 19:47:44 +0800 [thread overview]
Message-ID: <20260114-documents_gendwarfksyms-v2-1-297c98bd62c6@gmail.com> (raw)
In-Reply-To: <20260114-documents_gendwarfksyms-v2-0-297c98bd62c6@gmail.com>
From: Jihan LIN <linjh22s@gmail.com>
Although dependencies for gendwarfksyms were recently added to the
packaging rules [1-2], the corresponding documentation was missing.
Document the required build dependencies for gendwarfksyms, and
include a few examples for installing these dependencies on some
distributions.
[1] commit 657f96cb7c06 ("kbuild: deb-pkg: Add libdw-dev:native to
Build-Depends-Arch")
[2] commit 5bd6bdd0f76e ("kbuild: rpm-pkg: Add (elfutils-devel or
libdw-devel) to BuildRequires")
Signed-off-by: Jihan LIN <linjh22s@gmail.com>
---
Documentation/kbuild/gendwarfksyms.rst | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/Documentation/kbuild/gendwarfksyms.rst b/Documentation/kbuild/gendwarfksyms.rst
index ed366250a54eac3a72c2f529da94a9e803704ae4..0e153d13b052da6edcf65950739730c123cd49db 100644
--- a/Documentation/kbuild/gendwarfksyms.rst
+++ b/Documentation/kbuild/gendwarfksyms.rst
@@ -14,6 +14,29 @@ selected, **gendwarfksyms** is used instead to calculate symbol versions
from the DWARF debugging information, which contains the necessary
details about the final module ABI.
+Dependencies
+------------
+
+libelf, libdw and zlib are dependencies of gendwarfksyms.
+
+Here are a few examples for installing these dependencies:
+
+* Arch Linux and derivatives::
+
+ sudo pacman --needed -S zlib libelf
+
+* Debian, Ubuntu, and derivatives::
+
+ sudo apt install libelf-dev libdw-dev zlib1g-dev
+
+* Fedora and derivatives::
+
+ sudo dnf install elfutils-libelf-devel elfutils-devel zlib-devel
+
+* openSUSE and derivatives::
+
+ sudo zypper install libelf-devel libdw-devel zlib-devel
+
Usage
-----
--
2.51.0
next prev parent reply other threads:[~2026-01-14 11:48 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-14 11:47 [PATCH v2 0/2] gendwarfksyms: Document " Jihan LIN via B4 Relay
2026-01-14 11:47 ` Jihan LIN via B4 Relay [this message]
2026-01-20 12:17 ` [PATCH v2 1/2] Documentation/kbuild: Document gendwarfksyms " Petr Pavlu
2026-01-21 23:56 ` Nathan Chancellor
2026-01-14 11:47 ` [PATCH v2 2/2] Documentation/kbuild: gendwarfksyms: Style cleanup Jihan LIN via B4 Relay
2026-01-20 12:18 ` Petr Pavlu
2026-01-22 0:00 ` [PATCH v2 0/2] gendwarfksyms: Document build dependencies Nathan Chancellor
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=20260114-documents_gendwarfksyms-v2-1-297c98bd62c6@gmail.com \
--to=devnull+linjh22s.gmail.com@kernel.org \
--cc=boqun.feng@gmail.com \
--cc=corbet@lwn.net \
--cc=linjh22s@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-modules@vger.kernel.org \
--cc=masahiroy@kernel.org \
--cc=nathan@kernel.org \
--cc=nsc@kernel.org \
--cc=ojeda@kernel.org \
--cc=petr.pavlu@suse.com \
--cc=samitolvanen@google.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
all inboxes | Powered by JetHome®