docs/sysfs: Specify ABI documentation requirements
PATCH 1/1 docs/sysfs: Specify ABI documentation requirements
Although it is expected nowadays that every new sysfs attribute is documented under Documentation/ABI, this is not yet mentioned in the kernel documentation. This patch adds a note in the sysfs documentation about that requirement.
Signed-off-by Bart Van Assche <[email protected]>
Cc Greg Kroah-Hartman <[email protected]>
Cc Andrew Morton <[email protected]>
Cc Randy Dunlap <[email protected]>
--- Documentation/filesystems/sysfs.txt | 10 +++++++++- 1 files changed, 9 insertions(+), 1 deletions(-)
Documentation/filesystems/sysfs.txt +9 -1
@@ -4,7 +4,7 @@ sysfs - _The_ filesystem for exporting kernel objects. Patrick Mochel <[email protected]> Mike Murphy <[email protected]> -Revised: 15 July 2010 +Revised: 16 August 2011 Original: 10 January 2003
@@ -370,3 +370,11 @@ int driver_create_file(struct device_driver *, const struct driver_attribute *); void driver_remove_file(struct device_driver *, const struct driver_attribute *); +Documentation +~~~~~~~~~~~~~ + +The sysfs directory structure and the attributes in each directory define an +ABI between the kernel and user space. As for any ABI, it is important that +this ABI is stable and properly documented. All new sysfs attributes must be +documented in Documentation/ABI. See also Documentation/ABI/README for more +information.
Signature · 1 line
1.7.3.4