[PATCH v2 3/4] Documentation/ABI: mark /sys/kernel/fadump_* sysfs files deprecated
From: Sourabh Jain <hidden>
Date: 2019-10-18 13:06:25
Also in:
linux-doc, lkml
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
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 <redacted>
---
.../sysfs-kernel-fadump_enabled | 3 +++
.../sysfs-kernel-fadump_registered | 3 +++
.../sysfs-kernel-fadump_release_mem | 3 +++
.../sysfs-kernel-fadump_release_opalcore | 2 ++
Documentation/powerpc/firmware-assisted-dump.rst | 15 +++++++++++++--
5 files changed, 24 insertions(+), 2 deletions(-)
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 => removed}/sysfs-kernel-fadump_release_opalcore (84%)
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@lists.ozlabs.org
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 dcf925e53f0f..3d881701dc11 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_registered Date: Feb 2012 Contact: linuxppc-dev@lists.ozlabs.org
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@lists.ozlabs.org
diff --git a/Documentation/ABI/testing/sysfs-kernel-fadump_release_opalcore b/Documentation/ABI/removed/sysfs-kernel-fadump_release_opalcore
similarity index 84%
rename from Documentation/ABI/testing/sysfs-kernel-fadump_release_opalcore
rename to Documentation/ABI/removed/sysfs-kernel-fadump_release_opalcore
index 53313c1d4e7a..b42e768bf922 100644
--- a/Documentation/ABI/testing/sysfs-kernel-fadump_release_opalcore
+++ b/Documentation/ABI/removed/sysfs-kernel-fadump_release_opalcore@@ -1,3 +1,5 @@ +This ABI is moved to /sys/kernel/fadump/ directory. + What: /sys/kernel/fadump_release_opalcore Date: Sep 2019 Contact: linuxppc-dev@lists.ozlabs.org
diff --git a/Documentation/powerpc/firmware-assisted-dump.rst b/Documentation/powerpc/firmware-assisted-dump.rst
index 0455a78486d5..6e2d329efda9 100644
--- a/Documentation/powerpc/firmware-assisted-dump.rst
+++ b/Documentation/powerpc/firmware-assisted-dump.rst@@ -283,14 +283,25 @@ Here is the list of files under kernel sysfs: enhanced to use this interface to release the memory reserved for dump and continue without 2nd reboot. - /sys/kernel/fadump_release_opalcore +Note: /sys/kernel/fadump_release_opalcore sysfs has moved to + /sys/kernel/fadump/fadump_release_opalcore. + + /sys/kernel/fadump/fadump_release_opalcore This file is available only on OPAL based machines when FADump is active during capture kernel. This is used to release the memory used by the kernel to export /sys/firmware/opal/core file. To release this memory, echo '1' to it: - echo 1 > /sys/kernel/fadump_release_opalcore + echo 1 > /sys/kernel/fadump/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 Here is the list of files under powerpc debugfs: (Assuming debugfs is mounted on /sys/kernel/debug directory.)
--
2.17.2