iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ABI: stable/sysfs-module: better document modules

Browse Source 
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>
This commit is contained in:
Mauro Carvalho Chehab 2021-09-27 15:59:34 +02:00 committed by Greg Kroah-Hartman
parent 483f7d699f
commit 3b54fc5077
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Documentation/ABI/stable/sysfs-module
View File

@ -1,8 +1,7 @@
What: /sys/module The /sys/module tree consists of the following structure:
Description:
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 The name of the module that is in the kernel. This
module name will always show up if the module is loaded as a module name will always show up if the module is loaded as a
dynamic module. If it is built directly into the kernel, it 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 Note: The conditions of creation in the built-in case are not
by design and may be removed in the future. 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 This directory contains individual files that are each
individual parameters of the module that are able to be individual parameters of the module that are able to be
changed at runtime. See the individual module changed at runtime. See the individual module
@ -25,7 +25,8 @@ Description:
individual driver documentation for details as to the individual driver documentation for details as to the
stability of the different parameters. 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 If the module is able to be unloaded from the kernel, this file
will contain the current reference count of the module. will contain the current reference count of the module.