From 3f5f1f22ef10ee0278cef1243944c93aca01b236 Mon Sep 17 00:00:00 2001
From: Sourabh Jain <sourabhjain@linux.ibm.com>
Date: Wed, 11 Dec 2019 21:39:09 +0530
Subject: [PATCH 5/6] Documentation/ABI: Mark /sys/kernel/fadump_* sysfs files
deprecated
References: bsc#1160018 ltc#182902 jsc#SLE-9099
Patch-mainline: v5.7-rc1
Git-commit: 3f5f1f22ef10ee0278cef1243944c93aca01b236
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
Acked-by: Michal Suchanek <msuchanek@suse.de>
---
.../ABI/obsolete/sysfs-kernel-fadump_enabled | 9 +++++++++
.../ABI/obsolete/sysfs-kernel-fadump_registered | 10 ++++++++++
.../ABI/obsolete/sysfs-kernel-fadump_release_mem | 10 ++++++++++
.../ABI/testing/sysfs-kernel-fadump_enabled | 7 -------
.../ABI/testing/sysfs-kernel-fadump_registered | 8 --------
.../ABI/testing/sysfs-kernel-fadump_release_mem | 8 --------
Documentation/powerpc/firmware-assisted-dump.rst | 12 ++++++++++++
7 files changed, 41 insertions(+), 23 deletions(-)
create mode 100644 Documentation/ABI/obsolete/sysfs-kernel-fadump_enabled
create mode 100644 Documentation/ABI/obsolete/sysfs-kernel-fadump_registered
create mode 100644 Documentation/ABI/obsolete/sysfs-kernel-fadump_release_mem
delete mode 100644 Documentation/ABI/testing/sysfs-kernel-fadump_enabled
delete mode 100644 Documentation/ABI/testing/sysfs-kernel-fadump_registered
delete mode 100644 Documentation/ABI/testing/sysfs-kernel-fadump_release_mem
diff --git a/Documentation/ABI/obsolete/sysfs-kernel-fadump_enabled b/Documentation/ABI/obsolete/sysfs-kernel-fadump_enabled
new file mode 100644
index 000000000000..e9c2de8b3688
--- /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
index 000000000000..0360be39c98e
--- /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
index 000000000000..6ce0b129ab12
--- /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
index f73632b1c006..000000000000
--- 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
index dcf925e53f0f..000000000000
--- 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
index 9c20d64ab48d..000000000000
--- 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 345a3405206e..2cd65a0df9b8 100644
--- 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.)
--
2.23.0