Commit 3b54fc50 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Greg Kroah-Hartman
Browse files

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/35876c1eabbcd03170d658081030db980b403297.1632750608.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 483f7d69

Documentation/ABI/stable/sysfs-module

+7 −6
Original line number Diff line number Diff line 
What:		/sys/module

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

		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.