LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Arend van Spriel <aspriel@gmail.com>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: LKML <linux-kernel@vger.kernel.org>,
	Brian Norris <briannorris@chromium.org>,
	Arend van Spriel <aspriel@gmail.com>
Subject: [PATCH for-4.16 1/3] sysfs: improve devices-coredump description with user-space perspective
Date: Thu, 15 Mar 2018 10:55:23 +0100	[thread overview]
Message-ID: <1521107725-25027-2-git-send-email-aspriel@gmail.com> (raw)
In-Reply-To: <1521107725-25027-1-git-send-email-aspriel@gmail.com>

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

  reply	other threads:[~2018-03-15  9:55 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-03-15  9:55 [PATCH for-4.16 0/3] drivers: base: revise coredump ABI Arend van Spriel
2018-03-15  9:55 ` Arend van Spriel [this message]
2018-03-15 17:05   ` [PATCH for-4.16 1/3] sysfs: improve devices-coredump description with user-space perspective Brian Norris
2018-03-15 20:20     ` Arend van Spriel
2018-03-15  9:55 ` [PATCH for-4.16 2/3] drivers: change struct device_driver::coredump() return type to void Arend van Spriel
2018-03-23 16:55   ` Greg Kroah-Hartman
2018-03-24  8:50     ` Arend van Spriel
2018-03-24  9:04       ` Greg Kroah-Hartman
2018-03-24 14:10         ` Arend van Spriel
2018-04-06 10:13         ` Arend van Spriel
2018-04-06 14:46           ` Greg Kroah-Hartman
2018-04-06 19:35             ` Arend van Spriel
2018-04-07  7:49               ` Greg Kroah-Hartman
2018-03-15  9:55 ` [PATCH for-4.16 3/3] drivers: base: remove check for callback in coredump_store() Arend van Spriel
2018-03-23 16:56 ` [PATCH for-4.16 0/3] drivers: base: revise coredump ABI Greg Kroah-Hartman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1521107725-25027-2-git-send-email-aspriel@gmail.com \
    --to=aspriel@gmail.com \
    --cc=briannorris@chromium.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --subject='Re: [PATCH for-4.16 1/3] sysfs: improve devices-coredump description with user-space perspective' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).