Documentation/kbuild: Document gendwarfksyms build dependencies

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 657f96cb7c ("kbuild: deb-pkg: Add libdw-dev:native to Build-Depends-Arch")
[2] commit 5bd6bdd0f7 ("kbuild: rpm-pkg: Add (elfutils-devel or libdw-devel) to BuildRequires")

Signed-off-by: Jihan LIN <linjh22s@gmail.com>
Reviewed-by: Petr Pavlu <petr.pavlu@suse.com>
Link: https://patch.msgid.link/20260114-documents_gendwarfksyms-v2-1-297c98bd62c6@gmail.com
[nathan: Applied Petr's suggested changes from review and minor commit
         message formatting adjustments]
Signed-off-by: Nathan Chancellor <nathan@kernel.org>
This commit is contained in:
Jihan LIN 2026-01-14 19:47:44 +08:00 committed by Nathan Chancellor
parent d4271702ab
commit 983233ac2e
No known key found for this signature in database
GPG key ID: 1D6B269171C01A96

View file

@ -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
------------
gendwarfksyms depends on the libelf, libdw, and zlib libraries.
Here are a few examples of how to install these dependencies:
* Arch Linux and derivatives::
sudo pacman --needed -S libelf zlib
* 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
-----