Re: [PATCH] [net] dibs: Improve DIBS prompts and help texts

[Alexandra Winter]

On 13.05.26 15:29, Geert Uytterhoeven wrote:
> The Kconfig prompts for the DIBS options read:
> 
>     DIBS support (DIBS) [N/m/y/?]
>       intra-OS shortcut with dibs loopback (DIBS_LO) [N/y/?]
> 
> Clarify the DIBS prompt by expanding the acronym.

Thank you, yes that is an improvement.


> Capitalize the first character of the DIBS_LO prompt, and always write
> DIBS in full caps.

dibs is a shim layer between other kernel components and code pieces are
typically lowercase, same for sysfs paths. It is not some formal standard
that is documented anywhere in uppercase. So I'd like to keep it lowercase
in the help text.

> While at it, join the first two lines of the DIBS help text into a real
> sentence.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@xxxxxxxxx>
> ---
>  drivers/dibs/Kconfig | 18 +++++++++---------
>  1 file changed, 9 insertions(+), 9 deletions(-)
> 
> diff --git a/drivers/dibs/Kconfig b/drivers/dibs/Kconfig
> index 5dc347b9b2350667..f2dd4c3e7c5f6d72 100644
> --- a/drivers/dibs/Kconfig
> +++ b/drivers/dibs/Kconfig
> @@ -1,23 +1,23 @@
>  # SPDX-License-Identifier: GPL-2.0
>  config DIBS
> -	tristate "DIBS support"
> +	tristate "Direct Internal Buffer Sharing support"
>  	default n
>  	help
> -	  Direct Internal Buffer Sharing (DIBS)
> -	  A communication method that uses common physical (internal) memory
> -	  for synchronous direct access into a remote buffer.
> +	  Direct Internal Buffer Sharing (DIBS) is a communication method that

I could consider changing this to (dibs), if people think that is easier to read.
But I thought it more obvious this way.

> +	  uses common physical (internal) memory for synchronous direct access
> +	  into a remote buffer.
>  
>  	  Select this option to provide the abstraction layer between
> -	  dibs devices and dibs clients like the SMC protocol.
> -	  The module name is dibs.
> +	  DIBS devices and DIBS clients like the SMC protocol.
> +	  The module name is DIBS.

The module name is definitively dibs in lowercase.


>  
>  config DIBS_LO
> -	bool "intra-OS shortcut with dibs loopback"
> +	bool "Intra-OS shortcut with DIBS loopback"
>  	depends on DIBS
>  	default n
>  	help
> -	  DIBS_LO enables the creation of an software-emulated dibs device
> +	  DIBS_LO enables the creation of an software-emulated DIBS device
>  	  named lo which can be used for transferring data when communication
>  	  occurs within the same OS. This helps in convenient testing of
> -	  dibs clients, since dibs loopback is independent of architecture or
> +	  DIBS clients, since DIBS loopback is independent of architecture or
>  	  hardware.