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

Arend van Spriel
2018-03-15T20:20:43Z

On 3/15/2018 6:05 PM, Brian Norris wrote:
> On Thu, Mar 15, 2018 at 10:55:23AM +0100, Arend van Spriel wrote:
>> 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.
>
> s/ueven/uevent/

crap. I mean: Thanks ;-)

>>
>> - Available when CONFIG_DEV_COREDUMP is enabled.
>> + Available when CONFIG_DEV_COREDUMP is enabled and the device
>> + driver supports coredump generation.
>
> What about /sys/class/devcoredump/disabled? Maybe we just need a
> sysfs-class-devcoredump too, now that there's a formal method for
> triggering devcoredumps.

I am not sure about this. Not my daily routine so I can use some
opinions here. Not that yours does not count, but I would like to be
sure before respinning.

Regards,
Arend