Received-SPF: pass (google.com: domain of linux-kernel+bounces-56499-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Date: Wed, 7 Feb 2024 04:51:11 -0800
From: Kees Cook <keescook@chromium.org>
To: Yuanhe Shu <xiangzao@linux.alibaba.com>
Cc: tony.luck@intel.com, gpiccoli@igalia.com, shuah@kernel.org,
	corbet@lwn.net, xlpang@linux.alibaba.com,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-hardening@vger.kernel.org, linux-kselftest@vger.kernel.org
Subject: Re: [PATCH 2/3] Documentation: adjust pstore backend related document
Message-ID: <202402070449.3EFCB80700@keescook>
References: <20240207021921.206425-1-xiangzao@linux.alibaba.com>
 <20240207021921.206425-3-xiangzao@linux.alibaba.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20240207021921.206425-3-xiangzao@linux.alibaba.com>

On Wed, Feb 07, 2024 at 10:19:20AM +0800, Yuanhe Shu wrote:
> Pstore now supports multiple backends, adjust related document.
> 
> Signed-off-by: Yuanhe Shu <xiangzao@linux.alibaba.com>
> ---
>  Documentation/ABI/testing/pstore                | 8 ++++----
>  Documentation/admin-guide/kernel-parameters.txt | 4 +++-
>  2 files changed, 7 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/pstore b/Documentation/ABI/testing/pstore
> index d3cff4a7ee10..2cd67b502f11 100644
> --- a/Documentation/ABI/testing/pstore
> +++ b/Documentation/ABI/testing/pstore
> @@ -41,7 +41,7 @@ Description:	Generic interface to platform dependent persistent storage.
>  		persistent storage until at least this amount is reached.
>  		Default is 10 Kbytes.
>  
> -		Pstore only supports one backend at a time. If multiple
> -		backends are available, the preferred backend may be
> -		set by passing the pstore.backend= argument to the kernel at
> -		boot time.
> +		Pstore now supports multiple backends at a time. If multiple

I'd drop "now"

> +		backends are available, the registrable backends may be
> +		set by passing the pstore.backend= argument1, argument2...
> +		or pstore.backend= all to the kernel at boot time.

I think dropping the cases of " " after the "=" and "," above would make
this more readable (and syntactically correct).

> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index 31b3a25680d0..a8a109b822a9 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt
> @@ -4748,7 +4748,9 @@
>  			[HW,MOUSE] Controls Logitech smartscroll autorepeat.
>  			0 = disabled, 1 = enabled (default).
>  
> -	pstore.backend=	Specify the name of the pstore backend to use
> +	pstore.backend=backend1,...,backendN
> +			Specify the names of the pstore backends to use
> +			or =all for all available backends
>  
>  	pti=		[X86-64] Control Page Table Isolation of user and
>  			kernel address spaces.  Disabling this feature
> -- 
> 2.39.3
> 

Otherwise looks good.

-- 
Kees Cook