Rename project from libkmod to kmod

This commit is contained in:
Lucas De Marchi 2011-12-12 16:41:38 -02:00
parent 2411c07794
commit cb48c9b2e6
3 changed files with 69 additions and 57 deletions

60
README
View File

@ -1,58 +1,12 @@
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).
kmod - Linux kernel module handling
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 with 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 */
}
}
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.

View File

@ -1,9 +1,9 @@
AC_PREREQ(2.60)
AC_INIT([libkmod],
[0.1],
AC_INIT([kmod],
[1],
[],
[libkmod],
[http://git.profusion.mobi/cgit.cgi/lucas/libkmod/])
[kmod],
[http://git.profusion.mobi/cgit.cgi/kmod.git/])
AC_CONFIG_SRCDIR([libkmod/libkmod.c])
AC_CONFIG_AUX_DIR([build-aux])

58
libkmod/README Normal file
View File

@ -0,0 +1,58 @@
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 with 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 */
}
}