kmod/libkmod
Lucas De Marchi d4f659e12a Drop the one line short description on sources
Some are outdated, misleading or just repeat the same thing over and
over. Remove them as they are not needed.

Reviewed-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://lore.kernel.org/r/20240723185921.1005569-3-lucas.de.marchi@gmail.com
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-07-26 13:41:56 -05:00
..
docs libkmod: add weak dependecies 2024-05-08 23:37:38 -05:00
.gitignore Rename libabc to libkmod 2011-11-21 14:35:35 -02:00
COPYING Change licenses 2011-12-12 18:24:35 -02:00
libkmod-builtin.c Drop the one line short description on sources 2024-07-26 13:41:56 -05:00
libkmod-config.c Drop the one line short description on sources 2024-07-26 13:41:56 -05:00
libkmod-elf.c Drop the one line short description on sources 2024-07-26 13:41:56 -05:00
libkmod-file-xz.c libkmod: Move xz-related functions to separate file 2024-07-26 13:41:13 -05:00
libkmod-file-zlib.c libkmod: Move zlib-related functions to separate file 2024-07-26 13:41:24 -05:00
libkmod-file-zstd.c libkmod: Move zstd-related functions to separate file 2024-07-26 13:41:47 -05:00
libkmod-file.c Drop the one line short description on sources 2024-07-26 13:41:56 -05:00
libkmod-index.c Drop the one line short description on sources 2024-07-26 13:41:56 -05:00
libkmod-index.h Drop the one line short description on sources 2024-07-26 13:41:56 -05:00
libkmod-internal-file.h libkmod: Move zstd-related functions to separate file 2024-07-26 13:41:47 -05:00
libkmod-internal.h libkmod: add weak dependecies 2024-05-08 23:37:38 -05:00
libkmod-list.c Drop the one line short description on sources 2024-07-26 13:41:56 -05:00
libkmod-module.c Drop the one line short description on sources 2024-07-26 13:41:56 -05:00
libkmod-signature.c Drop the one line short description on sources 2024-07-26 13:41:56 -05:00
libkmod.c Drop the one line short description on sources 2024-07-26 13:41:56 -05:00
libkmod.h Drop the one line short description on sources 2024-07-26 13:41:56 -05:00
libkmod.pc.in add Zstandard compression support 2020-09-10 21:55:01 -07:00
libkmod.sym libkmod: move new weak API to separate section 2024-07-20 09:11:01 -05:00
Makefile build-sys: add small redirecting Makefiles 2014-03-06 01:59:58 -03:00
README README: Move items from TODO 2013-07-17 02:31:27 -03:00

libkmod - linux kernel module handling library

ABSTRACT
========

libkmod was created to allow programs to easily insert, remove and
list modules, also checking its properties, dependencies and aliases.

there is no shared/global context information and it can be used by
multiple sites on a single program, also being able to be used from
threads, although it's not thread safe (you must lock explicitly).


OVERVIEW
========

Every user should create and manage it's own library context with:

   struct kmod_ctx *ctx = kmod_new(kernel_dirname);
   kmod_unref(ctx);


Modules can be created by various means:

   struct kmod_module *mod;
   int err;

   err = kmod_module_new_from_path(ctx, path, &mod);
   if (err < 0) {
      /* code */
   } else {
      /* code */
      kmod_module_unref(mod);
   }

   err = kmod_module_new_from_name(ctx, name, &mod);
   if (err < 0) {
      /* code */
   } else {
      /* code */
      kmod_module_unref(mod);
   }


Or could be resolved from a known alias to a list of alternatives:

   struct kmod_list *list, *itr;
   int err;
   err = kmod_module_new_from_lookup(ctx, alias, &list);
   if (err < 0) {
      /* code */
   } else {
      kmod_list_foreach(itr, list) {
         struct kmod_module *mod = kmod_module_get_module(itr);
         /* code */
      }
   }