diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2021-09-27 15:59:34 +0200 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2021-09-28 12:48:14 +0200 |
| commit | 3b54fc5077dade7c400fbc08b02bd65e5edd5cc0 (patch) | |
| tree | 811b60ea3e3796eac9e63a0723312247c2934e41 /Documentation/ABI/stable | |
| parent | 483f7d699fd96d494dbd299f73d758073c73c147 (diff) | |
| download | linux-3b54fc5077dade7c400fbc08b02bd65e5edd5cc0.tar.gz | |
ABI: stable/sysfs-module: better document modules
Instead of placing almost everything there as a text, use
the proper What: for each component of the ABI.
This allows it to be better documented and parsed by
get_abi.pl.
While here, use wildcards for MODULENAME.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/35876c1eabbcd03170d658081030db980b403297.1632750608.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/ABI/stable')
| -rw-r--r-- | Documentation/ABI/stable/sysfs-module | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/Documentation/ABI/stable/sysfs-module b/Documentation/ABI/stable/sysfs-module index 6272ae5fb3669..5c028af9921ab 100644 --- a/Documentation/ABI/stable/sysfs-module +++ b/Documentation/ABI/stable/sysfs-module @@ -1,8 +1,7 @@ -What: /sys/module -Description: - The /sys/module tree consists of the following structure: +The /sys/module tree consists of the following structure: - /sys/module/MODULENAME +What: /sys/module/<MODULENAME> +Description: The name of the module that is in the kernel. This module name will always show up if the module is loaded as a dynamic module. If it is built directly into the kernel, it @@ -12,7 +11,8 @@ Description: 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 +What: /sys/module/<MODULENAME>/parameters +Description: This directory contains individual files that are each individual parameters of the module that are able to be changed at runtime. See the individual module @@ -25,7 +25,8 @@ Description: individual driver documentation for details as to the stability of the different parameters. - /sys/module/MODULENAME/refcnt +What: /sys/module/<MODULENAME>/refcnt +Description: If the module is able to be unloaded from the kernel, this file will contain the current reference count of the module. |