[PATCH 5/9] ABI: sysfs-module: better document module name parameter

From: Mauro Carvalho Chehab
Date: Wed Sep 08 2021 - 10:59:07 EST


On almost all ABI documents, variable arguments are declared
as <foo_bar>. Change it here too, in order to allow replacing
such wildcards by regexes on a scriptable way.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
---
Documentation/ABI/stable/sysfs-module | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/Documentation/ABI/stable/sysfs-module b/Documentation/ABI/stable/sysfs-module
index 6272ae5fb366..c60c7a6f5aff 100644
--- a/Documentation/ABI/stable/sysfs-module
+++ b/Documentation/ABI/stable/sysfs-module
@@ -2,7 +2,7 @@ What: /sys/module
Description:
The /sys/module tree consists of the following structure:

- /sys/module/MODULENAME
+ /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 +12,7 @@ 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
+ /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,10 +25,14 @@ Description:
individual driver documentation for details as to the
stability of the different parameters.

- /sys/module/MODULENAME/refcnt
+ /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.

Note: If the module is built into the kernel, or if the
CONFIG_MODULE_UNLOAD kernel configuration value is not enabled,
this file will not be present.
+
+ /sys/module/<MODULENAME>/srcversion
+ If the module source has MODULE_VERSION, this file will contain
+ the version of the source code.
--
2.31.1