[PATCH 01/17] ABI: stable/sysfs-module: better document modules

From: Mauro Carvalho Chehab
Date: Mon Sep 27 2021 - 10:00:17 EST

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

While here, use wildcards for MODULENAME.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>

See [PATCH 00/17] at: https://lore.kernel.org/all/cover.1632750608.git.mchehab+huawei@xxxxxxxxxx/

Documentation/ABI/stable/sysfs-module | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/Documentation/ABI/stable/sysfs-module b/Documentation/ABI/stable/sysfs-module
index 6272ae5fb366..5c028af9921a 100644
--- a/Documentation/ABI/stable/sysfs-module
+++ b/Documentation/ABI/stable/sysfs-module
@@ -1,8 +1,7 @@
-What: /sys/module
- 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>
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
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
If the module is able to be unloaded from the kernel, this file
will contain the current reference count of the module.