[PATCH] remoteproc: sysfs: Fix stale coredump attribute documentation

[PATCH] remoteproc: sysfs: Fix stale coredump attribute documentation

[Yonghao Zhang]

The documentation of the 'coredump' sysfs entry still advertises a
"default" configuration option and describes it as the default value
of the entry.  Both date back to before the option was renamed to
"enabled" and the default configuration was changed to "disabled".

Update the comment to describe the three options the store callback
actually accepts, "disabled", "enabled" and "inline", along with the
real default value, and fix the coredump_show() comment which wrongly
claims the configuration is exposed via debugfs.

Fixes: bf41a0910cb2 ("remoteproc: Change default dump configuration to "disabled"")
Assisted-by: Claude-Code:glm-5.3
Signed-off-by: Yonghao Zhang <hyz3367@gmail.com>
---
 drivers/remoteproc/remoteproc_sysfs.c | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/drivers/remoteproc/remoteproc_sysfs.c b/drivers/remoteproc/remoteproc_sysfs.c
index 925b0cdbe577..c37736ff4acc 100644
--- a/drivers/remoteproc/remoteproc_sysfs.c
+++ b/drivers/remoteproc/remoteproc_sysfs.c
@@ -76,7 +76,7 @@ static const char * const rproc_coredump_str[] = {
 	[RPROC_COREDUMP_INLINE]		= "inline",
 };
 
-/* Expose the current coredump configuration via debugfs */
+/* Expose the current coredump configuration via sysfs */
 static ssize_t coredump_show(struct device *dev,
 			     struct device_attribute *attr, char *buf)
 {
@@ -87,14 +87,15 @@ static ssize_t coredump_show(struct device *dev,
 
 /*
  * By writing to the 'coredump' sysfs entry, we control the behavior of the
- * coredump mechanism dynamically. The default value of this entry is "default".
+ * coredump mechanism dynamically. The default value of this entry is
+ * "disabled".
  *
  * The 'coredump' sysfs entry supports these commands:
  *
  * disabled:	This is the default coredump mechanism. Recovery will proceed
  *		without collecting any dump.
  *
- * default:	When the remoteproc crashes the entire coredump will be
+ * enabled:	When the remoteproc crashes the entire coredump will be
  *		copied to a separate buffer and exposed to userspace.
  *
  * inline:	The coredump will not be copied to a separate buffer and the
-- 
2.34.1

Re: [PATCH] remoteproc: sysfs: Fix stale coredump attribute documentation

[Mathieu Poirier]

On Fri, Sep 11, 2026 at 11:09:44AM +0800, Yonghao Zhang wrote:
> The documentation of the 'coredump' sysfs entry still advertises a
> "default" configuration option and describes it as the default value
> of the entry.  Both date back to before the option was renamed to
> "enabled" and the default configuration was changed to "disabled".
> 
> Update the comment to describe the three options the store callback
> actually accepts, "disabled", "enabled" and "inline", along with the
> real default value, and fix the coredump_show() comment which wrongly
> claims the configuration is exposed via debugfs.
> 
> Fixes: bf41a0910cb2 ("remoteproc: Change default dump configuration to "disabled"")
> Assisted-by: Claude-Code:glm-5.3
> Signed-off-by: Yonghao Zhang <hyz3367@gmail.com>
> ---
>  drivers/remoteproc/remoteproc_sysfs.c | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
>

I applied both of your patches.

Thanks,
Mathieu
 
> diff --git a/drivers/remoteproc/remoteproc_sysfs.c b/drivers/remoteproc/remoteproc_sysfs.c
> index 925b0cdbe577..c37736ff4acc 100644
> --- a/drivers/remoteproc/remoteproc_sysfs.c
> +++ b/drivers/remoteproc/remoteproc_sysfs.c
> @@ -76,7 +76,7 @@ static const char * const rproc_coredump_str[] = {
>  	[RPROC_COREDUMP_INLINE]		= "inline",
>  };
>  
> -/* Expose the current coredump configuration via debugfs */
> +/* Expose the current coredump configuration via sysfs */
>  static ssize_t coredump_show(struct device *dev,
>  			     struct device_attribute *attr, char *buf)
>  {
> @@ -87,14 +87,15 @@ static ssize_t coredump_show(struct device *dev,
>  
>  /*
>   * By writing to the 'coredump' sysfs entry, we control the behavior of the
> - * coredump mechanism dynamically. The default value of this entry is "default".
> + * coredump mechanism dynamically. The default value of this entry is
> + * "disabled".
>   *
>   * The 'coredump' sysfs entry supports these commands:
>   *
>   * disabled:	This is the default coredump mechanism. Recovery will proceed
>   *		without collecting any dump.
>   *
> - * default:	When the remoteproc crashes the entire coredump will be
> + * enabled:	When the remoteproc crashes the entire coredump will be
>   *		copied to a separate buffer and exposed to userspace.
>   *
>   * inline:	The coredump will not be copied to a separate buffer and the
> -- 
> 2.34.1
>