[PATCH v2] RISC-V: align ISA extension Kconfig help text with each other

[PATCH v2] RISC-V: align ISA extension Kconfig help text with each other

[Conor Dooley]

Other extensions only capitalise the first letter in the text visible
in Kconfig menus, and provide a short comment about the extension's
meaning. Do the same for Svnapot & Svpbmt.

The precedent for capitalisation in the Kconfig text was set by Zicbom
& sorta followed for Zicboz. The RVI styling used for multi-letter
extensions only capitalises the first letter, so do the same here.
If nothing else, my OCD likes it when the extensions follow a consistent
pattern.

While editing one of the lines, reformat the "spelling" of 64-bit.

Signed-off-by: Conor Dooley <conor.dooley@microchip.com>
---
Changes in v2:
- do the same for Svnapot too
- s/ZICBOZ/Zicboz
---
 arch/riscv/Kconfig | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/arch/riscv/Kconfig b/arch/riscv/Kconfig
index cc02eb9eee1f..92e8b4d908b6 100644
--- a/arch/riscv/Kconfig
+++ b/arch/riscv/Kconfig
@@ -400,31 +400,31 @@ config RISCV_ISA_C
 	  If you don't know what to do here, say Y.
 
 config RISCV_ISA_SVNAPOT
-	bool "SVNAPOT extension support"
+	bool "Svnapot extension support for supervisor mode NAPOT pages"
 	depends on 64BIT && MMU
 	depends on RISCV_ALTERNATIVE
 	default y
 	help
-	  Allow kernel to detect the SVNAPOT ISA-extension dynamically at boot
+	  Allow kernel to detect the Svnapot ISA-extension dynamically at boot
 	  time and enable its usage.
 
-	  The SVNAPOT extension is used to mark contiguous PTEs as a range
+	  The Svnapot extension is used to mark contiguous PTEs as a range
 	  of contiguous virtual-to-physical translations for a naturally
 	  aligned power-of-2 (NAPOT) granularity larger than the base 4KB page
 	  size. When HUGETLBFS is also selected this option unconditionally
 	  allocates some memory for each NAPOT page size supported by the kernel.
 	  When optimizing for low memory consumption and for platforms without
-	  the SVNAPOT extension, it may be better to say N here.
+	  the Svnapot extension, it may be better to say N here.
 
 	  If you don't know what to do here, say Y.
 
 config RISCV_ISA_SVPBMT
-	bool "SVPBMT extension support"
+	bool "Svpbmt extension support for supervisor mode page-based memory types"
 	depends on 64BIT && MMU
 	depends on RISCV_ALTERNATIVE
 	default y
 	help
-	   Adds support to dynamically detect the presence of the SVPBMT
+	   Adds support to dynamically detect the presence of the Svpbmt
 	   ISA-extension (Supervisor-mode: page-based memory types) and
 	   enable its usage.
 
@@ -432,7 +432,7 @@ config RISCV_ISA_SVPBMT
 	   that indicate the cacheability, idempotency, and ordering
 	   properties for access to that page.
 
-	   The SVPBMT extension is only available on 64Bit cpus.
+	   The Svpbmt extension is only available on 64-bit cpus.
 
 	   If you don't know what to do here, say Y.
 
@@ -482,7 +482,7 @@ config RISCV_ISA_ZICBOZ
 	depends on RISCV_ALTERNATIVE
 	default y
 	help
-	   Enable the use of the ZICBOZ extension (cbo.zero instruction)
+	   Enable the use of the Zicboz extension (cbo.zero instruction)
 	   when available.
 
 	   The Zicboz extension is used for faster zeroing of memory.
-- 
2.39.2


_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv

Re: [PATCH v2] RISC-V: align ISA extension Kconfig help text with each other

[Heiko Stübner]

Am Mittwoch, 5. April 2023, 12:21:10 CEST schrieb Conor Dooley:
> Other extensions only capitalise the first letter in the text visible
> in Kconfig menus, and provide a short comment about the extension's
> meaning. Do the same for Svnapot & Svpbmt.
> 
> The precedent for capitalisation in the Kconfig text was set by Zicbom
> & sorta followed for Zicboz. The RVI styling used for multi-letter
> extensions only capitalises the first letter, so do the same here.
> If nothing else, my OCD likes it when the extensions follow a consistent
> pattern.
> 
> While editing one of the lines, reformat the "spelling" of 64-bit.
> 
> Signed-off-by: Conor Dooley <conor.dooley@microchip.com>

I do believe it makes a lot of sense to follow the official spelling
(first letter upper case). This will make it also easier for later additions
to also not create own casing-forms :-) .

Reviewed-by: Heiko Stuebner <heiko.stuebner@vrull.eu>

> ---
> Changes in v2:
> - do the same for Svnapot too
> - s/ZICBOZ/Zicboz
> ---
>  arch/riscv/Kconfig | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/arch/riscv/Kconfig b/arch/riscv/Kconfig
> index cc02eb9eee1f..92e8b4d908b6 100644
> --- a/arch/riscv/Kconfig
> +++ b/arch/riscv/Kconfig
> @@ -400,31 +400,31 @@ config RISCV_ISA_C
>  	  If you don't know what to do here, say Y.
>  
>  config RISCV_ISA_SVNAPOT
> -	bool "SVNAPOT extension support"
> +	bool "Svnapot extension support for supervisor mode NAPOT pages"
>  	depends on 64BIT && MMU
>  	depends on RISCV_ALTERNATIVE
>  	default y
>  	help
> -	  Allow kernel to detect the SVNAPOT ISA-extension dynamically at boot
> +	  Allow kernel to detect the Svnapot ISA-extension dynamically at boot
>  	  time and enable its usage.
>  
> -	  The SVNAPOT extension is used to mark contiguous PTEs as a range
> +	  The Svnapot extension is used to mark contiguous PTEs as a range
>  	  of contiguous virtual-to-physical translations for a naturally
>  	  aligned power-of-2 (NAPOT) granularity larger than the base 4KB page
>  	  size. When HUGETLBFS is also selected this option unconditionally
>  	  allocates some memory for each NAPOT page size supported by the kernel.
>  	  When optimizing for low memory consumption and for platforms without
> -	  the SVNAPOT extension, it may be better to say N here.
> +	  the Svnapot extension, it may be better to say N here.
>  
>  	  If you don't know what to do here, say Y.
>  
>  config RISCV_ISA_SVPBMT
> -	bool "SVPBMT extension support"
> +	bool "Svpbmt extension support for supervisor mode page-based memory types"
>  	depends on 64BIT && MMU
>  	depends on RISCV_ALTERNATIVE
>  	default y
>  	help
> -	   Adds support to dynamically detect the presence of the SVPBMT
> +	   Adds support to dynamically detect the presence of the Svpbmt
>  	   ISA-extension (Supervisor-mode: page-based memory types) and
>  	   enable its usage.
>  
> @@ -432,7 +432,7 @@ config RISCV_ISA_SVPBMT
>  	   that indicate the cacheability, idempotency, and ordering
>  	   properties for access to that page.
>  
> -	   The SVPBMT extension is only available on 64Bit cpus.
> +	   The Svpbmt extension is only available on 64-bit cpus.
>  
>  	   If you don't know what to do here, say Y.
>  
> @@ -482,7 +482,7 @@ config RISCV_ISA_ZICBOZ
>  	depends on RISCV_ALTERNATIVE
>  	default y
>  	help
> -	   Enable the use of the ZICBOZ extension (cbo.zero instruction)
> +	   Enable the use of the Zicboz extension (cbo.zero instruction)
>  	   when available.
>  
>  	   The Zicboz extension is used for faster zeroing of memory.
> 





_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv

Re: [PATCH v2] RISC-V: align ISA extension Kconfig help text with each other

[Andrew Jones]

On Wed, Apr 05, 2023 at 11:21:10AM +0100, Conor Dooley wrote:
> Other extensions only capitalise the first letter in the text visible
> in Kconfig menus, and provide a short comment about the extension's
> meaning. Do the same for Svnapot & Svpbmt.
> 
> The precedent for capitalisation in the Kconfig text was set by Zicbom
> & sorta followed for Zicboz. The RVI styling used for multi-letter
> extensions only capitalises the first letter, so do the same here.
> If nothing else, my OCD likes it when the extensions follow a consistent
> pattern.
> 
> While editing one of the lines, reformat the "spelling" of 64-bit.
> 
> Signed-off-by: Conor Dooley <conor.dooley@microchip.com>
> ---
> Changes in v2:
> - do the same for Svnapot too
> - s/ZICBOZ/Zicboz
> ---
>  arch/riscv/Kconfig | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
>

Reviewed-by: Andrew Jones <ajones@ventanamicro.com>

_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv

Re: [PATCH v2] RISC-V: align ISA extension Kconfig help text with each other

[Palmer Dabbelt]

On Wed, 05 Apr 2023 11:21:10 +0100, Conor Dooley wrote:
> Other extensions only capitalise the first letter in the text visible
> in Kconfig menus, and provide a short comment about the extension's
> meaning. Do the same for Svnapot & Svpbmt.
> 
> The precedent for capitalisation in the Kconfig text was set by Zicbom
> & sorta followed for Zicboz. The RVI styling used for multi-letter
> extensions only capitalises the first letter, so do the same here.
> If nothing else, my OCD likes it when the extensions follow a consistent
> pattern.
> 
> [...]

Applied, thanks!

[1/1] RISC-V: align ISA extension Kconfig help text with each other
      https://git.kernel.org/palmer/c/5464912cfae7

Best regards,
-- 
Palmer Dabbelt <palmer@rivosinc.com>


_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv

Re: [PATCH v2] RISC-V: align ISA extension Kconfig help text with each other

[patchwork-bot+linux-riscv]

Hello:

This patch was applied to riscv/linux.git (for-next)
by Palmer Dabbelt <palmer@rivosinc.com>:

On Wed, 5 Apr 2023 11:21:10 +0100 you wrote:
> Other extensions only capitalise the first letter in the text visible
> in Kconfig menus, and provide a short comment about the extension's
> meaning. Do the same for Svnapot & Svpbmt.
> 
> The precedent for capitalisation in the Kconfig text was set by Zicbom
> & sorta followed for Zicboz. The RVI styling used for multi-letter
> extensions only capitalises the first letter, so do the same here.
> If nothing else, my OCD likes it when the extensions follow a consistent
> pattern.
> 
> [...]

Here is the summary with links:
  - [v2] RISC-V: align ISA extension Kconfig help text with each other
    https://git.kernel.org/riscv/c/5464912cfae7

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html



_______________________________________________
linux-riscv mailing list
linux-riscv@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-riscv