ABI: Clarify when /sys/module/MODULENAME is created
authorJean Delvare <khali@linux-fr.org>
Tue, 2 Jul 2013 06:05:11 +0000 (15:35 +0930)
committerRusty Russell <rusty@rustcorp.com.au>
Tue, 2 Jul 2013 06:08:20 +0000 (15:38 +0930)
/sys/module/MODULENAME is not created unconditionally. This can be
confusing so document the current conditions.

Signed-off-by: Jean Delvare <khali@linux-fr.org>
Cc: Rusty Russell <rusty@rustcorp.com.au>
Cc: Rob Landley <rob@landley.net>
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Documentation/ABI/stable/sysfs-module

index a0dd21c..6272ae5 100644 (file)
@@ -4,9 +4,13 @@ Description:
 
        /sys/module/MODULENAME
                The name of the module that is in the kernel.  This
-               module name will show up either if the module is built
-               directly into the kernel, or if it is loaded as a
-               dynamic module.
+               module name will always show up if the module is loaded as a
+               dynamic module.  If it is built directly into the kernel, it
+               will only show up if it has a version or at least one
+               parameter.
+
+               Note: The conditions of creation in the built-in case are not
+               by design and may be removed in the future.
 
        /sys/module/MODULENAME/parameters
                This directory contains individual files that are each