[v2,3/4] Documentation/ABI: mark /sys/kernel/fadump_* sysfs files deprecated
diff mbox series

Message ID 20191018130557.2217-4-sourabhjain@linux.ibm.com
State Superseded
Headers show
Series
  • reorganize and add FADump sysfs files
Related show

Checks

Context Check Description
snowpatch_ozlabs/checkpatch success total: 0 errors, 0 warnings, 0 checks, 50 lines checked
snowpatch_ozlabs/apply_patch success Successfully applied on branch next (600802af9049be799465b24d14162918545634bf)

Commit Message

Sourabh Jain Oct. 18, 2019, 1:05 p.m. UTC
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@linux.ibm.com>
---
 .../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%)

Comments

Hari Bathini Oct. 21, 2019, 7:41 a.m. UTC | #1
On 18/10/19 6:35 PM, Sourabh Jain wrote:
> The /sys/kernel/fadump_* sysfs files are replicated under

[...]

> +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/* looks tidy instead of /sys/kernel/fadump/fadump_* 
I mean, /sys/kernel/fadump/fadump_enabled => /sys/kernel/fadump/enabled and such..

- Hari
Sourabh Jain Nov. 5, 2019, 8:54 a.m. UTC | #2
On 10/21/19 1:11 PM, Hari Bathini wrote:
> 
> 
> On 18/10/19 6:35 PM, Sourabh Jain wrote:
>> The /sys/kernel/fadump_* sysfs files are replicated under
> 
> [...]
> 
>> +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/* looks tidy instead of /sys/kernel/fadump/fadump_* 
> I mean, /sys/kernel/fadump/fadump_enabled => /sys/kernel/fadump/enabled and such..



Could you please confirm whether you want to address the sysfs file path differently or
actually changing the sysfs file name from fadump_enabled to enabled.

- Sourabh Jain
Hari Bathini Nov. 5, 2019, 5:01 p.m. UTC | #3
On 05/11/19 2:24 PM, Sourabh Jain wrote:
> 
> 
> On 10/21/19 1:11 PM, Hari Bathini wrote:
>>
>>
>> On 18/10/19 6:35 PM, Sourabh Jain wrote:
>>> The /sys/kernel/fadump_* sysfs files are replicated under
>>
>> [...]
>>
>>> +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/* looks tidy instead of /sys/kernel/fadump/fadump_* 
>> I mean, /sys/kernel/fadump/fadump_enabled => /sys/kernel/fadump/enabled and such..
> 
> 
> 
> Could you please confirm whether you want to address the sysfs file path differently or
> actually changing the sysfs file name from fadump_enabled to enabled.

I meant, given the path "/sys/kernel/fadump/", the prefix fadump_ is redundant.
If there are no conventions that we should retain the same file name, I suggest
to drop the fadump_ prefix and just call them enabled, registered, etc..

- Hari
Sourabh Jain Nov. 6, 2019, 5:29 a.m. UTC | #4
On 11/5/19 10:31 PM, Hari Bathini wrote:
> 
> 
> On 05/11/19 2:24 PM, Sourabh Jain wrote:
>>
>>
>> On 10/21/19 1:11 PM, Hari Bathini wrote:
>>>
>>>
>>> On 18/10/19 6:35 PM, Sourabh Jain wrote:
>>>> The /sys/kernel/fadump_* sysfs files are replicated under
>>>
>>> [...]
>>>
>>>> +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/* looks tidy instead of /sys/kernel/fadump/fadump_* 
>>> I mean, /sys/kernel/fadump/fadump_enabled => /sys/kernel/fadump/enabled and such..
>>
>>
>>
>> Could you please confirm whether you want to address the sysfs file path differently or
>> actually changing the sysfs file name from fadump_enabled to enabled.
> 
> I meant, given the path "/sys/kernel/fadump/", the prefix fadump_ is redundant.
> If there are no conventions that we should retain the same file name, I suggest
> to drop the fadump_ prefix and just call them enabled, registered, etc..

Oh Yes, I agree with you. It's better not to prefix the sysfs files with fadump_. As we already
have directory that convey the same information.

I did not find any rule regarding renaming an obsolete sysfs file in Documentation/ABI/README.
So lets remove the fadump_ prefix from fadump sysfs file. 

Thanks,
Sourabh Jain

Patch
diff mbox series

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.)