Documentation/ABI: Mark /sys/kernel/fadump_* sysfs files deprecated

Add a deprecation note in FADump sysfs ABI documentation files and
move them from ABI/testing to ABI/obsolete directory.

Signed-off-by: Sourabh Jain <sourabhjain@linux.ibm.com>
[mpe: Use a proper table to fix errors from the documentation build]
Signed-off-by: Michael Ellerman <mpe@ellerman.id.au>
Link: https://lore.kernel.org/r/20191211160910.21656-6-sourabhjain@linux.ibm.com

diff --git a/Documentation/ABI/obsolete/sysfs-kernel-fadump_enabled b/Documentation/ABI/obsolete/sysfs-kernel-fadump_enabled
new file mode 100644 (file)
index 0000000..e9c2de8
--- /dev/null
+++ b/Documentation/ABI/obsolete/sysfs-kernel-fadump_enabled
@@ -0,0 +1,9 @@
+This ABI is renamed and moved to a new location /sys/kernel/fadump/enabled.
+
+What:          /sys/kernel/fadump_enabled
+Date:          Feb 2012
+Contact:       linuxppc-dev@lists.ozlabs.org
+Description:   read only
+               Primarily used to identify whether the FADump is enabled in
+               the kernel or not.
+User:          Kdump service

diff --git a/Documentation/ABI/obsolete/sysfs-kernel-fadump_registered b/Documentation/ABI/obsolete/sysfs-kernel-fadump_registered
new file mode 100644 (file)
index 0000000..0360be3
--- /dev/null
+++ b/Documentation/ABI/obsolete/sysfs-kernel-fadump_registered
@@ -0,0 +1,10 @@
+This ABI is renamed and moved to a new location /sys/kernel/fadump/registered.¬
+
+What:          /sys/kernel/fadump_registered
+Date:          Feb 2012
+Contact:       linuxppc-dev@lists.ozlabs.org
+Description:   read/write
+               Helps to control the dump collect feature from userspace.
+               Setting 1 to this file enables the system to collect the
+               dump and 0 to disable it.
+User:          Kdump service

diff --git a/Documentation/ABI/obsolete/sysfs-kernel-fadump_release_mem b/Documentation/ABI/obsolete/sysfs-kernel-fadump_release_mem
new file mode 100644 (file)
index 0000000..6ce0b12
--- /dev/null
+++ b/Documentation/ABI/obsolete/sysfs-kernel-fadump_release_mem
@@ -0,0 +1,10 @@
+This ABI is renamed and moved to a new location /sys/kernel/fadump/release_mem.¬
+
+What:          /sys/kernel/fadump_release_mem
+Date:          Feb 2012
+Contact:       linuxppc-dev@lists.ozlabs.org
+Description:   write only
+               This is a special sysfs file and only available when
+               the system is booted to capture the vmcore using FADump.
+               It is used to release the memory reserved by FADump to
+               save the crash dump.

diff --git a/Documentation/ABI/testing/sysfs-kernel-fadump_enabled b/Documentation/ABI/testing/sysfs-kernel-fadump_enabled
deleted file mode 100644 (file)
index f73632b..0000000
--- a/Documentation/ABI/testing/sysfs-kernel-fadump_enabled
+++ /dev/null
@@ -1,7 +0,0 @@
-What:          /sys/kernel/fadump_enabled
-Date:          Feb 2012
-Contact:       linuxppc-dev@lists.ozlabs.org
-Description:   read only
-               Primarily used to identify whether the FADump is enabled in
-               the kernel or not.
-User:          Kdump service

diff --git a/Documentation/ABI/testing/sysfs-kernel-fadump_registered b/Documentation/ABI/testing/sysfs-kernel-fadump_registered
deleted file mode 100644 (file)
index dcf925e..0000000
--- a/Documentation/ABI/testing/sysfs-kernel-fadump_registered
+++ /dev/null
@@ -1,8 +0,0 @@
-What:          /sys/kernel/fadump_registered
-Date:          Feb 2012
-Contact:       linuxppc-dev@lists.ozlabs.org
-Description:   read/write
-               Helps to control the dump collect feature from userspace.
-               Setting 1 to this file enables the system to collect the
-               dump and 0 to disable it.
-User:          Kdump service

diff --git a/Documentation/ABI/testing/sysfs-kernel-fadump_release_mem b/Documentation/ABI/testing/sysfs-kernel-fadump_release_mem
deleted file mode 100644 (file)
index 9c20d64..0000000
--- a/Documentation/ABI/testing/sysfs-kernel-fadump_release_mem
+++ /dev/null
@@ -1,8 +0,0 @@
-What:          /sys/kernel/fadump_release_mem
-Date:          Feb 2012
-Contact:       linuxppc-dev@lists.ozlabs.org
-Description:   write only
-               This is a special sysfs file and only available when
-               the system is booted to capture the vmcore using FADump.
-               It is used to release the memory reserved by FADump to
-               save the crash dump.

diff --git a/Documentation/powerpc/firmware-assisted-dump.rst b/Documentation/powerpc/firmware-assisted-dump.rst
index 345a3405206ed6ed8ad4c026a62433b2a1825a4b..2cd65a0df9b8a760f088b635df43f0557fd75a4d 100644 (file)
--- a/Documentation/powerpc/firmware-assisted-dump.rst
+++ b/Documentation/powerpc/firmware-assisted-dump.rst
@@ -295,6 +295,18 @@ Note: /sys/kernel/fadump_release_opalcore sysfs has moved to
 
     echo 1  > /sys/firmware/opal/mpipl/release_core
 
+Note: The following FADump sysfs files are deprecated.
+
++----------------------------------+--------------------------------+
+| Deprecated                       | Alternative                    |
++----------------------------------+--------------------------------+
+| /sys/kernel/fadump_enabled       | /sys/kernel/fadump/enabled     |
++----------------------------------+--------------------------------+
+| /sys/kernel/fadump_registered    | /sys/kernel/fadump/registered  |
++----------------------------------+--------------------------------+
+| /sys/kernel/fadump_release_mem   | /sys/kernel/fadump/release_mem |
++----------------------------------+--------------------------------+
+
 Here is the list of files under powerpc debugfs:
 (Assuming debugfs is mounted on /sys/kernel/debug directory.)