From cd923111c6c5352d7fa1b9a73fde25008b47c7f5 Mon Sep 17 00:00:00 2001
From: Lucas De Marchi <lucas.demarchi@intel.com>
Date: Wed, 17 Jul 2013 02:26:47 -0300
Subject: README: Move items from TODO

Put the differences between kmod and module-init-tools in the README
file so it's more visible.
---
 README         | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 TODO           | 51 ---------------------------------------------------
 libkmod/README |  2 +-
 3 files changed, 58 insertions(+), 52 deletions(-)

diff --git a/README b/README
index 65499cc..a2a2a5c 100644
--- a/README
+++ b/README
@@ -59,3 +59,60 @@ Gitweb:
 
 Irc:
 	#kmod on irc.freenode.org
+
+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
diff --git a/TODO b/TODO
index e3f81d1..50e7483 100644
--- a/TODO
+++ b/TODO
@@ -47,54 +47,3 @@ Things to be added/removed in kernel (check what is really needed):
 
 * kill /proc/modules ?
 	- Unlikely, given other tools might depend on it
-
-
-
-Things that are different from module-init-tools on purpose (!TODO)
-===================================================================
-
-modprobe
---------
-
-* 'modprobe -l' was marked as deprecated and does not exist anymore
-
-* 'modprobe -t' is gone, together with 'modprobe -l'
-
-* there's and additional '--remove-dependencies' flags to modprobe so we
-  can remove modules depending on that one
-
-* 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
------
-
-* information is parsed from /sys instead of /proc/modules
diff --git a/libkmod/README b/libkmod/README
index d0ca2fc..3e1c8dc 100644
--- a/libkmod/README
+++ b/libkmod/README
@@ -20,7 +20,7 @@ Every user should create and manage it's own library context with:
    kmod_unref(ctx);
 
 
-Modules can be created with by various means:
+Modules can be created by various means:
 
    struct kmod_module *mod;
    int err;
-- 
cgit v1.2.1