[PATCH for-4.16 1/3] sysfs: improve devices-coredump description with user-space perspective

Arend van Spriel
2018-03-15T09:55:23Z

Instead of referring to kernel internals, describe the ABI from user-space
perspective to clarify what can be expected when using it.

Signed-off-by: Arend van Spriel <aspriel@gmail.com>
---
Documentation/ABI/testing/sysfs-devices-coredump | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-devices-coredump b/Documentation/ABI/testing/sysfs-devices-coredump
index e459368..d5a4c75 100644
--- a/Documentation/ABI/testing/sysfs-devices-coredump
+++ b/Documentation/ABI/testing/sysfs-devices-coredump
@@ -2,9 +2,13 @@ What: /sys/devices/.../coredump
Date: December 2017
Contact: Arend van Spriel <aspriel@gmail.com>
Description:
- The /sys/devices/.../coredump attribute is only present when the
- device is bound to a driver, which provides the .coredump()
- callback. The attribute is write only. Anything written to this
- file will trigger the .coredump() callback.
+ When present the /sys/devices/.../coredump attribute can be used
+ to trigger a coredump of the device. The coredump contents are
+ device driver specific and thus vary. The coredump attribute is
+ writeonly. Anything written to this file will trigger creation
+ of the coredump. When the coredump is made available under
+ /sys/class/devcoredump it will generate a uevent. When the
+ coredump can not be successfully generated no ueven will occur.

- Available when CONFIG_DEV_COREDUMP is enabled.
+ Available when CONFIG_DEV_COREDUMP is enabled and the device
+ driver supports coredump generation.
--
1.9.1