Doug / smarc-fsl-linux-kernel

Download as
Browse Code ยป

Commit 86028619b9f653a30f5aa0d331fdedd899a1eea5

Authored by Bart Van Assche
Committed by Greg Kroah-Hartman
1 parent bd33d12fba
Exists in master and in 6 other branches imx_3.10.17_1.0.1_ga, imx_3.10.53_1.1.0_ga, imx_3.14.28_1.0.0_ga, smarc-imx_3.10.53_1.1.0_ga, smarc-imx_3.14.28_1.0.0_ga, smarc-l5.0.0_1.0.0-ga

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 <bvanassche@acm.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>

Showing 1 changed file with 9 additions and 1 deletions Side-by-side Diff

Documentation/filesystems/sysfs.txt
Diff comments   View file @ 8602861
... ... @@ -4,7 +4,7 @@
4 4 Patrick Mochel <mochel@osdl.org>
5 5 Mike Murphy <mamurph@cs.clemson.edu>
6 6  
7   -Revised: 15 July 2010
  7 +Revised: 16 August 2011
8 8 Original: 10 January 2003
9 9  
10 10  
... ... @@ -368,4 +368,14 @@
368 368  
369 369 int driver_create_file(struct device_driver *, const struct driver_attribute *);
370 370 void driver_remove_file(struct device_driver *, const struct driver_attribute *);
  371 +
  372 +
  373 +Documentation
  374 +~~~~~~~~~~~~~
  375 +
  376 +The sysfs directory structure and the attributes in each directory define an
  377 +ABI between the kernel and user space. As for any ABI, it is important that
  378 +this ABI is stable and properly documented. All new sysfs attributes must be
  379 +documented in Documentation/ABI. See also Documentation/ABI/README for more
  380 +information.