[PATCH 3/4] Documentation/ABI: mark /sys/kernel/fadump_* sysfs files deprecated

From: Sourabh Jain
Date: Sun Sep 15 2019 - 09:23:34 EST


The /sys/kernel/fadump_* sysfs files are replicated under
/sys/kernel/fadump/ directory. But we need to keep the old
sysfs files to maintain the backward compatibility.

The sysfs files are scheduled to remove by 2021.

Signed-off-by: Sourabh Jain <sourabhjain@xxxxxxxxxxxxx>
---
.../{testing => obsolete}/sysfs-kernel-fadump_enabled | 3 +++
.../{testing => obsolete}/sysfs-kernel-fadump_registered | 3 +++
.../sysfs-kernel-fadump_release_mem | 3 +++
.../sysfs-kernel-fadump_release_opalcore | 3 +++
Documentation/powerpc/firmware-assisted-dump.rst | 9 +++++++++
5 files changed, 21 insertions(+)
rename Documentation/ABI/{testing => obsolete}/sysfs-kernel-fadump_enabled (66%)
rename Documentation/ABI/{testing => obsolete}/sysfs-kernel-fadump_registered (71%)
rename Documentation/ABI/{testing => obsolete}/sysfs-kernel-fadump_release_mem (73%)
rename Documentation/ABI/{testing => obsolete}/sysfs-kernel-fadump_release_opalcore (70%)

diff --git a/Documentation/ABI/testing/sysfs-kernel-fadump_enabled b/Documentation/ABI/obsolete/sysfs-kernel-fadump_enabled
similarity index 66%
rename from Documentation/ABI/testing/sysfs-kernel-fadump_enabled
rename to Documentation/ABI/obsolete/sysfs-kernel-fadump_enabled
index f73632b1c006..ca35a285905b 100644
--- a/Documentation/ABI/testing/sysfs-kernel-fadump_enabled
+++ b/Documentation/ABI/obsolete/sysfs-kernel-fadump_enabled
@@ -1,3 +1,6 @@
+This ABI is deprecated and will be removed after 2021. It is replaced
+with /sys/kernel/fadump/fadump_enabled.
+
What: /sys/kernel/fadump_enabled
Date: Feb 2012
Contact: linuxppc-dev@xxxxxxxxxxxxxxxx
diff --git a/Documentation/ABI/testing/sysfs-kernel-fadump_registered b/Documentation/ABI/obsolete/sysfs-kernel-fadump_registered
similarity index 71%
rename from Documentation/ABI/testing/sysfs-kernel-fadump_registered
rename to Documentation/ABI/obsolete/sysfs-kernel-fadump_registered
index 972e8c427ad4..2c1bc4adafb4 100644
--- a/Documentation/ABI/testing/sysfs-kernel-fadump_registered
+++ b/Documentation/ABI/obsolete/sysfs-kernel-fadump_registered
@@ -1,3 +1,6 @@
+This ABI is deprecated and will be removed after 2021. It is replaced
+with /sys/kernel/fadump/fadump_registered.
+
What: /sys/kernel/fadump/fadump_registered
Date: Feb 2012
Contact: linuxppc-dev@xxxxxxxxxxxxxxxx
diff --git a/Documentation/ABI/testing/sysfs-kernel-fadump_release_mem b/Documentation/ABI/obsolete/sysfs-kernel-fadump_release_mem
similarity index 73%
rename from Documentation/ABI/testing/sysfs-kernel-fadump_release_mem
rename to Documentation/ABI/obsolete/sysfs-kernel-fadump_release_mem
index 9c20d64ab48d..8fef37d9b5ba 100644
--- a/Documentation/ABI/testing/sysfs-kernel-fadump_release_mem
+++ b/Documentation/ABI/obsolete/sysfs-kernel-fadump_release_mem
@@ -1,3 +1,6 @@
+This ABI is deprecated and will be removed after 2021. It is replaced
+with /sys/kernel/fadump/fadump_release_mem.
+
What: /sys/kernel/fadump_release_mem
Date: Feb 2012
Contact: linuxppc-dev@xxxxxxxxxxxxxxxx
diff --git a/Documentation/ABI/testing/sysfs-kernel-fadump_release_opalcore b/Documentation/ABI/obsolete/sysfs-kernel-fadump_release_opalcore
similarity index 70%
rename from Documentation/ABI/testing/sysfs-kernel-fadump_release_opalcore
rename to Documentation/ABI/obsolete/sysfs-kernel-fadump_release_opalcore
index 53313c1d4e7a..c02be8f4471e 100644
--- a/Documentation/ABI/testing/sysfs-kernel-fadump_release_opalcore
+++ b/Documentation/ABI/obsolete/sysfs-kernel-fadump_release_opalcore
@@ -1,3 +1,6 @@
+This ABI is deprecated and will be removed after 2021. It is replaced
+with /sys/kernel/fadump/fadump_release_opalcore.
+
What: /sys/kernel/fadump_release_opalcore
Date: Sep 2019
Contact: linuxppc-dev@xxxxxxxxxxxxxxxx
diff --git a/Documentation/powerpc/firmware-assisted-dump.rst b/Documentation/powerpc/firmware-assisted-dump.rst
index 0455a78486d5..4fd7f5eab97d 100644
--- a/Documentation/powerpc/firmware-assisted-dump.rst
+++ b/Documentation/powerpc/firmware-assisted-dump.rst
@@ -292,6 +292,15 @@ Here is the list of files under kernel sysfs:

echo 1 > /sys/kernel/fadump_release_opalcore

+Note: The following FADump sysfs files are deprecated.
+
+ Deprecated Alternative
+ -------------------------------------------------------------------------------
+ /sys/kernel/fadump_enabled /sys/kernel/fadump/fadump_enabled
+ /sys/kernel/fadump_registered /sys/kernel/fadump/fadump_registered
+ /sys/kernel/fadump_release_mem /sys/kernel/fadump/fadump_release_mem
+ /sys/kernel/fadump_release_opalcore /sys/kernel/fadump/fadump_release_opalcore
+
Here is the list of files under powerpc debugfs:
(Assuming debugfs is mounted on /sys/kernel/debug directory.)

--
2.17.2