[v2] fs: Kconfig: Alignment of code and text in the FS_DAX help section for better readability

[PATCH V2] fs: Kconfig: Alignment of code and text in the FS_DAX help section for better readability

Posted by Bhaskar Chowdhury 1 month ago

I thought eliminating the line break and add an empty line would improve the
readability.

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202608240313.d7SDG2tE-lkp@intel.com/

Signed-off-by: Bhaskar Chowdhury <unixbhaskar@gmail.com>
---
 Changes from V1:
 Getting rid of the unwanted ":" ;that was the source of build failure.
 fs/Kconfig | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/fs/Kconfig b/fs/Kconfig
index e05917adcd60..a2e724cae76f 100644
--- a/fs/Kconfig
+++ b/fs/Kconfig
@@ -71,11 +71,10 @@ config FS_DAX
 	  struct pages.  For the nfit based NVDIMMs this can be enabled
 	  using the ndctl utility:

-		# ndctl create-namespace --force --reconfig=namespace0.0 \
-			--mode=fsdax --map=mem
+	  # ndctl create-namespace --force --reconfig=namespace0.0 --mode=fsdax --map=mem
+
+	  See the 'create-namespace' man page for details on the overhead of --map=mem

-	  See the 'create-namespace' man page for details on the overhead of
-	  --map=mem:
 	  https://docs.pmem.io/ndctl-user-guide/ndctl-man-pages/ndctl-create-namespace

 	  For ndctl to work CONFIG_DEV_DAX needs to be enabled as well. For most
--
2.54.0

Re: [PATCH V2] fs: Kconfig: Alignment of code and text in the FS_DAX help section for better readability

Posted by Jan Kara 3 weeks, 5 days ago

On Mon 24-08-26 02:50:18, Bhaskar Chowdhury wrote:
> I thought eliminating the line break and add an empty line would improve the
> readability.
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202608240313.d7SDG2tE-lkp@intel.com/
> 
> Signed-off-by: Bhaskar Chowdhury <unixbhaskar@gmail.com>

I don't know. It depends on the width of your terminal what's more
readable. I'd just leave it as is.

								Honza

> ---
>  Changes from V1:
>  Getting rid of the unwanted ":" ;that was the source of build failure.
>  fs/Kconfig | 7 +++----
>  1 file changed, 3 insertions(+), 4 deletions(-)
> 
> diff --git a/fs/Kconfig b/fs/Kconfig
> index e05917adcd60..a2e724cae76f 100644
> --- a/fs/Kconfig
> +++ b/fs/Kconfig
> @@ -71,11 +71,10 @@ config FS_DAX
>  	  struct pages.  For the nfit based NVDIMMs this can be enabled
>  	  using the ndctl utility:
> 
> -		# ndctl create-namespace --force --reconfig=namespace0.0 \
> -			--mode=fsdax --map=mem
> +	  # ndctl create-namespace --force --reconfig=namespace0.0 --mode=fsdax --map=mem
> +
> +	  See the 'create-namespace' man page for details on the overhead of --map=mem
> 
> -	  See the 'create-namespace' man page for details on the overhead of
> -	  --map=mem:
>  	  https://docs.pmem.io/ndctl-user-guide/ndctl-man-pages/ndctl-create-namespace
> 
>  	  For ndctl to work CONFIG_DEV_DAX needs to be enabled as well. For most
> --
> 2.54.0
> 
-- 
Jan Kara <jack@suse.com>
SUSE Labs, CR