diff options
| author | Jihan LIN | 2026-01-14 19:47:44 +0800 |
|---|---|---|
| committer | Nathan Chancellor | 2026-01-21 16:58:42 -0700 |
| commit | 983233ac2ef1b6a423419e0542734e8f79802124 (patch) | |
| tree | a94f7f2cffb2dd95f66e23f3e7f4fc6e8ef8c52c /Documentation/kbuild | |
| parent | d4271702ab2fb0e4474ce66e3c68dfbdf8dc3e4c (diff) | |
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 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>
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>
Diffstat (limited to 'Documentation/kbuild')
| -rw-r--r-- | Documentation/kbuild/gendwarfksyms.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/Documentation/kbuild/gendwarfksyms.rst b/Documentation/kbuild/gendwarfksyms.rst index ed366250a54e..c5e4617b4b41 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 +------------ + +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 ----- |