korg/kmod
0
0
Fork 0
mirror of https://git.kernel.org/pub/scm/utils/kernel/kmod/kmod.git synced 2024-11-14 22:43:44 +08:00
Code Issues Packages Projects Releases Wiki Activity
1,846 Commits 3 Branches 33 Tags 11 MiB
C 86.4%
M4 3.6%
Shell 3.5%
Meson 3.5%
Makefile 3%
5c3ea2f45d
Go to file
Emil Velikov 5c3ea2f45d README.md: adjust the optional dependency note 
With last commit we've default-enabled a few options. So the optional
dependencies become required now.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/225
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-11-07 10:10:34 -06:00
.github meson: default enable compression and openssl 2024-11-07 10:10:34 -06:00
libkmod libkmod: Fix typo in comment 2024-11-04 07:26:44 -06:00
m4 m4: remove verbose license exception clause 2024-08-10 11:03:26 -05:00
man meson: switch to / operator instead of join_paths() 2024-10-24 17:46:25 -05:00
scripts meson: bump to 0.61, use install_symlink() 2024-10-24 18:10:12 -05:00
shared libkmod: Unify READV usages 2024-10-18 14:00:27 -05:00
shell-completion shell-completion/*/insmod: add bash/fish/zsh completion 2024-09-22 16:11:57 -05:00
testsuite meson: switch to / operator instead of join_paths() 2024-10-24 17:46:25 -05:00
tools tools: Use options_from_array in insmod 2024-10-23 22:10:39 -05:00
.clang-format libkmod: Unify READV usages 2024-10-18 14:00:27 -05:00
.codespellignore ci: add more SPDX copyright/license identifiers 2024-09-27 23:08:09 -05:00
.editorconfig ci: add more SPDX copyright/license identifiers 2024-09-27 23:08:09 -05:00
.gitignore gitignore: ignore gtk-doc.m4 2024-07-03 10:14:47 -05:00
.mailmap .mailmap: Forward to my personal email 2024-06-14 13:49:03 -05:00
autogen.sh ci: build: add docs in ci/developer builds 2024-09-06 14:39:06 -05:00
build-dev.ini Enable sanitizers in build-dev.ini 2024-10-18 13:22:11 -05:00
CODING-STYLE CONTRIBUTING.md: mention s-o-b tag, includ DCO copy 2024-09-16 21:49:47 -05:00
configure.ac Always define and use ENABLE_ELFDBG 2024-10-17 09:27:15 -05:00
CONTRIBUTING.md CONTRIBUTING.md: mention about gtk-doc Since: 2024-10-23 23:19:11 -05:00
COPYING Clarify what licences apply where 2014-10-09 01:26:34 -03:00
DCO.txt CONTRIBUTING.md: mention s-o-b tag, includ DCO copy 2024-09-16 21:49:47 -05:00
Makefile.am meson: bump to 0.61, use install_symlink() 2024-10-24 18:10:12 -05:00
meson_options.txt meson: default enable compression and openssl 2024-11-07 10:10:34 -06:00
meson.build meson: don't escape module_foo in kmod.pc 2024-11-01 10:35:21 -05:00
NEWS Address all codespell (flagged) typos 2024-08-16 17:05:43 -05:00
README.md README.md: adjust the optional dependency note 2024-11-07 10:10:34 -06:00

README.md

kmod - Linux kernel module handling

OVERVIEW

kmod is a set of tools to handle common tasks with Linux kernel modules like insert, remove, list, check properties, resolve dependencies and aliases.

These tools are designed on top of libkmod, a library that is shipped with kmod. See libkmod/README for more details on this library and how to use it. The aim is to be compatible with tools, configurations and indexes from module-init-tools project.

Links

Compilation and installation

In order to compile the source code you need the following software packages:

  • GCC/CLANG compiler
  • GNU C library / musl / uClibc

Optional dependencies, required with the default build configuration:

  • ZLIB library
  • LZMA library
  • ZSTD library
  • OPENSSL library (signature handling in modinfo)

Typical configuration and installation

meson setup builddir/
meson compile -C builddir/
sudo meson install -C builddir/

Alternatively you can try autotools build. NOTE: The autotools build is slated for removal with kmod v35

./configure CFLAGS="-g -O2" --prefix=/usr \
            --sysconfdir=/etc --libdir=/usr/lib

Configure automatically searches for all required components and packages.

To compile and install run:

make && make install

Hacking

When working on kmod, use the included build-dev.ini file, as:

meson setup --native-file build-dev.ini builddir/

Make sure to read our contributing guide and the other READMEs: libkmod and testsuite.

Compatibility with module-init-tools

kmod replaced module-init-tools, which was EOL'ed in 2011. All the tools were rewritten on top of libkmod and they can be used as drop in replacements. Along the years there were a few behavior changes and new features implemented, following feedback from Linux kernel community and distros.