README: update to a decade+ later

Commit Message

Lucas De Marchi July 12, 2024, 1:24 p.m. UTC

- State support for clang and other libc's
- Fix typos
- Reword the compatibility with module-init-tools section,
  removing most of the specific examples as we didn't keep
  track of all of them, and they are not important anymore
  in year 2024

Signed-off-by: Lucas De Marchi <[e-mail]>
---
 README.md | 65 +++++++------------------------------------------------
 1 file changed, 8 insertions(+), 57 deletions(-)

Comments

Emil Velikov July 17, 2024, 5:15 p.m. UTC | #1

On Fri, 12 Jul 2024 at 14:25, Lucas De Marchi <[e-mail]> wrote:
>
> - State support for clang and other libc's
> - Fix typos
> - Reword the compatibility with module-init-tools section,
>   removing most of the specific examples as we didn't keep
>   track of all of them, and they are not important anymore
>   in year 2024
>
> Signed-off-by: Lucas De Marchi <[e-mail]>
> ---
>  README.md | 65 +++++++------------------------------------------------
>  1 file changed, 8 insertions(+), 57 deletions(-)
>
> diff --git a/README.md b/README.md
> index 9b22bd7..1aa023d 100644
> --- a/README.md
> +++ b/README.md
> @@ -44,9 +44,9 @@ module-init-tools project.
>  Compilation and installation
>  ============================
>
> -In order to compiler the source code you need following software packages:
> -       - GCC compiler
> -       - GNU C library
> +In order to compile the source code you need following software packages:

s/need following/need the following/ perhaps?

Although feel free to land it as-is. There are a few nitpicks/markdown
fixes that I will send as follow-up.

In either case:
Reviewed-by: Emil Velikov <[e-mail]>

> +       - GCC/CLANG compiler
> +       - GNU C library / musl / uClibc
>

Will add a patch for clang permutation, as your CI series lands.

-Emil

Patch

diff --git a/README.md b/README.md
index 9b22bd7..1aa023d 100644
--- a/README.md
+++ b/README.md
@@ -44,9 +44,9 @@  module-init-tools project.
 Compilation and installation
 ============================
 
-In order to compiler the source code you need following software packages:
-	- GCC compiler
-	- GNU C library
+In order to compile the source code you need following software packages:
+	- GCC/CLANG compiler
+	- GNU C library / musl / uClibc
 
 Optional dependencies:
 	- ZLIB library
@@ -67,7 +67,7 @@  Hacking
 =======
 
 Run 'autogen.sh' script before configure. If you want to accept the recommended
-flags, you just need to run 'autogen.sh c'.
+flags, you just need to run `autogen.sh c`.
 
 Make sure to read the CODING-STYLE file and the other READMEs: libkmod/README
 and testsuite/README.
@@ -75,56 +75,7 @@  and testsuite/README.
 Compatibility with module-init-tools
 ====================================
 
-kmod replaces module-init-tools, which is end-of-life. Most of its tools are
-rewritten on top of libkmod so it can be used as a drop in replacements.
-Somethings however were changed. Reasons vary from "the feature was already
-long deprecated on module-init-tools" to "it would be too much trouble to
-support it".
-
-There are several features that are being added in kmod, but we don't
-keep track of them here.
-
-modprobe
---------
-
-* 'modprobe -l' was marked as deprecated and does not exist anymore
-
-* 'modprobe -t' is gone, together with 'modprobe -l'
-
-* modprobe doesn't parse configuration files with names not ending in
-  '.alias' or '.conf'. modprobe used to warn about these files.
-
-* modprobe doesn't parse 'config' and 'include' commands in configuration
-  files.
-
-* modprobe from m-i-t does not honour softdeps for install commands. E.g.:
-  config:
-
-        install bli "echo bli"
-	install bla "echo bla"
-	softdep bla pre: bli
-
-  With m-i-t, the output of 'modprobe --show-depends bla' will be:
-        install "echo bla"
-
-  While with kmod:
-        install "echo bli"
-        install "echo bla"
-
-* kmod doesn't dump the configuration as is in the config files. Instead it
-  dumps the configuration as it was parsed. Therefore, comments and file names
-  are not dumped, but on the good side we know what the exact configuration
-  kmod is using. We did this because if we only want to know the entire content
-  of configuration files, it's enough to use find(1) in modprobe.d directories
-
-depmod
-------
-
-* there's no 'depmod -m' option: legacy modules.*map files are gone
-
-lsmod
------
-
-* module-init-tools used /proc/modules to parse module info. kmod uses
-  /sys/module/*, but there's a fallback to /proc/modules if the latter isn't
-  available
+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.