The patch titled docs/sysfs: specify ABI documentation requirements has been added to the -mm tree. Its filename is docs-sysfs-specify-abi-documentation-requirements.patch Before you just go and hit "reply", please: a) Consider who else should be cc'ed b) Prefer to cc a suitable mailing list as well c) Ideally: find the original patch on the mailing list and do a reply-to-all to that, adding suitable additional cc's *** Remember to use Documentation/SubmitChecklist when testing your code *** See http://userweb.kernel.org/~akpm/stuff/added-to-mm.txt to find out what to do about this The current -mm tree may be found at http://userweb.kernel.org/~akpm/mmotm/ ------------------------------------------------------ Subject: docs/sysfs: specify ABI documentation requirements From: Bart Van Assche <bvanassche@xxxxxxx> 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@xxxxxxx> Cc: Greg Kroah-Hartman <gregkh@xxxxxxx> Cc: Randy Dunlap <rdunlap@xxxxxxxxxxxx> Signed-off-by: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx> --- Documentation/filesystems/sysfs.txt | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff -puN Documentation/filesystems/sysfs.txt~docs-sysfs-specify-abi-documentation-requirements Documentation/filesystems/sysfs.txt --- a/Documentation/filesystems/sysfs.txt~docs-sysfs-specify-abi-documentation-requirements +++ a/Documentation/filesystems/sysfs.txt @@ -4,7 +4,7 @@ sysfs - _The_ filesystem for exporting k Patrick Mochel <mochel@xxxxxxxx> Mike Murphy <mamurph@xxxxxxxxxxxxxx> -Revised: 15 July 2010 +Revised: 16 August 2011 Original: 10 January 2003 @@ -370,3 +370,11 @@ int driver_create_file(struct device_dri 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. _ Patches currently in -mm which might be from bvanassche@xxxxxxx are docs-sysfs-specify-abi-documentation-requirements.patch -- To unsubscribe from this list: send the line "unsubscribe mm-commits" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html