diff options
author | Greg Kroah-Hartman <gregkh@suse.de> | 2006-04-27 16:17:19 -0700 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@suse.de> | 2006-04-27 16:17:19 -0700 |
commit | a615fe02db67e84a9b206f47a5e888f1d2638637 (patch) | |
tree | 5d72e941eb329c13a2a668a7bf807bbd62033033 /driver | |
parent | 25c44edd42842c825d6a42e8bca0c0caf52a04f7 (diff) | |
download | patches-a615fe02db67e84a9b206f47a5e888f1d2638637.tar.gz |
update for stable api docs patch
Diffstat (limited to 'driver')
-rw-r--r-- | driver/stable-abi-docs.patch | 71 |
1 files changed, 36 insertions, 35 deletions
diff --git a/driver/stable-abi-docs.patch b/driver/stable-abi-docs.patch index eda122e31f60c3..3c89df2c656885 100644 --- a/driver/stable-abi-docs.patch +++ b/driver/stable-abi-docs.patch @@ -9,32 +9,32 @@ Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de> Documentation/ABI/README | 77 ++++++++++++++++++++++++++++++++ Documentation/ABI/obsolete/devfs | 13 +++++ Documentation/ABI/stable/syscalls | 10 ++++ - Documentation/ABI/stable/sysfs-module | 29 ++++++++++++ + Documentation/ABI/stable/sysfs-module | 30 ++++++++++++ Documentation/ABI/testing/sysfs-class | 16 ++++++ Documentation/ABI/testing/sysfs-devices | 25 ++++++++++ - 6 files changed, 170 insertions(+) + 6 files changed, 171 insertions(+) --- /dev/null +++ gregkh-2.6/Documentation/ABI/README @@ -0,0 +1,77 @@ +This directory attempts to document the ABI between the Linux kernel and +userspace, and the relative stability of these interfaces. Due to the -+ever changing nature of Linux, and the differing maturity levels, these ++everchanging nature of Linux, and the differing maturity levels, these +interfaces should be used by userspace programs in different ways. + +We have four different levels of ABI stability, as shown by the four -+different subdirectorys in this location. Interfaces may change levels ++different subdirectories in this location. Interfaces may change levels +of stability according to the rules described below. + +The different levels of stability are: + + stable/ -+ This directory documents the interfaces that have the developer -+ has defined to be stable. Userspace programs are free to use -+ these interfaces with no restrictions, and backward -+ compatibility for them will be guaranteed for at least 2 years. -+ Most simple interfaces (like syscalls) are expected to never -+ change and always be available. ++ This directory documents the interfaces that the developer has ++ defined to be stable. Userspace programs are free to use these ++ interfaces with no restrictions, and backward compatibility for ++ them will be guaranteed for at least 2 years. Most interfaces ++ (like syscalls) are expected to never change and always be ++ available. + + testing/ + This directory documents interfaces that are felt to be stable, @@ -70,17 +70,17 @@ Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de> +KernelVersion: Kernel version this feature first showed up in. +Contact: Primary contact for this interface (may be a mailing list) +Description: Long description of the interface and how to use it. -+Users: All users of this interface who wish to be notified for -+ when it changes. This is very important for interfaces in ++Users: All users of this interface who wish to be notified when ++ it changes. This is very important for interfaces in + the "testing" stage, so that kernel developers can work + with userspace developers to ensure that things do not -+ break in ways that are unacceptable. It is also important -+ to get feedback for these interfaces to make sure they are -+ working in a proper way and do not need to be changed -+ further. ++ break in ways that are unacceptable. It is also ++ important to get feedback for these interfaces to make ++ sure they are working in a proper way and do not need to ++ be changed further. + + -+How things move between states: ++How things move between levels: + +Interfaces in stable may move to obsolete, as long as the proper +notification is given. @@ -89,10 +89,10 @@ Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de> +documented amount of time has gone by. + +Interfaces in the testing state can move to the stable state when the -+developers feel they are finished. They can not be removed from the ++developers feel they are finished. They cannot be removed from the +kernel tree without going through the obsolete state first. + -+It's up to the developer to place their interface in the category they ++It's up to the developer to place their interfaces in the category they +wish for it to start out in. --- /dev/null +++ gregkh-2.6/Documentation/ABI/obsolete/devfs @@ -120,33 +120,34 @@ Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de> + over time, and not have things removed from it. + + Note that this interface is different for every architecture -+ that Linux supports. Please see the arch specific documentation -+ for details on the syscall numbers that are to be mapped to each -+ syscall. ++ that Linux supports. Please see the architecture-specific ++ documentation for details on the syscall numbers that are to be ++ mapped to each syscall. --- /dev/null +++ gregkh-2.6/Documentation/ABI/stable/sysfs-module -@@ -0,0 +1,29 @@ +@@ -0,0 +1,30 @@ +What: /sys/module +Description: + The /sys/module tree consists of the following structure: + + /sys/module/MODULENAME -+ The name of the module that is in the kernel. -+ This module name will show up both if the module is built -+ directly into the kernel, or if it is loaded as a dyanmic -+ module. ++ The name of the module that is in the kernel. This ++ module name will show up either if the module is built ++ directly into the kernel, or if it is loaded as a ++ dyanmic module. + + /sys/module/MODULENAME/parameters + This directory contains individual files that are each -+ individual parameters into the module that are are able to be -+ changed at runtime. See the individual module documentation as -+ to the contents of these parameters and what they accomplish. ++ individual parameters of the module that are able to be ++ changed at runtime. See the individual module ++ documentation as to the contents of these parameters and ++ what they accomplish. + + Note: The individual parameter names and values are not -+ considered stable, only the fact that they will be placed into -+ this location within sysfs. See the individual driver -+ documentation for details as to the stability of the different -+ parameters. ++ considered stable, only the fact that they will be ++ placed in this location within sysfs. See the ++ individual driver documentation for details as to the ++ stability of the different parameters. + + /sys/module/MODULENAME/refcnt + If the module is able to be unloaded from the kernel, this file @@ -198,7 +199,7 @@ Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de> + + Note that sometimes not all devices along the directory + chain will have emitted uevent messages, so userspace -+ programs must be able to handle such occurances. ++ programs must be able to handle such occurrences. + +Users: + udev <linux-hotplug-devel@lists.sourceforge.net> |