Documentation/ABI: Mark /sys/kernel/fadump_* sysfs files deprecated
authorSourabh Jain <sourabhjain@linux.ibm.com>
Wed, 11 Dec 2019 16:09:09 +0000 (21:39 +0530)
committerMichael Ellerman <mpe@ellerman.id.au>
Wed, 19 Feb 2020 11:45:36 +0000 (22:45 +1100)
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
Documentation/ABI/obsolete/sysfs-kernel-fadump_enabled [moved from Documentation/ABI/testing/sysfs-kernel-fadump_enabled with 73% similarity]
Documentation/ABI/obsolete/sysfs-kernel-fadump_registered [moved from Documentation/ABI/testing/sysfs-kernel-fadump_registered with 77% similarity]
Documentation/ABI/obsolete/sysfs-kernel-fadump_release_mem [moved from Documentation/ABI/testing/sysfs-kernel-fadump_release_mem with 78% similarity]
Documentation/powerpc/firmware-assisted-dump.rst

@@ -1,3 +1,5 @@
+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
@@ -1,3 +1,5 @@
+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
@@ -1,3 +1,5 @@
+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
index 345a340..2cd65a0 100644 (file)
@@ -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.)