diff mbox series

[v4,2/2] xen: add (EXPERT) to one-line descriptions when appropriate

Message ID 20210125212747.26676-2-sstabellini@kernel.org (mailing list archive)
State Superseded
Headers show
Series introduce UNSUPPORTED | expand

Commit Message

Stefano Stabellini Jan. 25, 2021, 9:27 p.m. UTC
Add an "(EXPERT)" tag to the one-line description of Kconfig options
that depend on EXPERT.

Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
CC: andrew.cooper3@citrix.com
CC: george.dunlap@citrix.com
CC: iwj@xenproject.org
CC: jbeulich@suse.com
CC: julien@xen.org
CC: wl@xen.org

---
Changes in v4:
- new patch
---
 xen/arch/x86/Kconfig     |  2 +-
 xen/common/Kconfig       | 12 ++++++------
 xen/common/sched/Kconfig |  2 +-
 3 files changed, 8 insertions(+), 8 deletions(-)

Comments

Jan Beulich Jan. 26, 2021, 9:26 a.m. UTC | #1
On 25.01.2021 22:27, Stefano Stabellini wrote:
> --- a/xen/arch/x86/Kconfig
> +++ b/xen/arch/x86/Kconfig
> @@ -103,7 +103,7 @@ config HVM
>  	  If unsure, say Y.
>  
>  config XEN_SHSTK
> -	bool "Supervisor Shadow Stacks"
> +	bool "Supervisor Shadow Stacks (EXPERT)"
>  	depends on HAS_AS_CET_SS && EXPERT
>  	default y
>  	---help---

I agree with this addition, but I'm afraid I'm at least uncertain
about all the other ones made here, where ...

> --- a/xen/common/Kconfig
> +++ b/xen/common/Kconfig
> @@ -12,7 +12,7 @@ config CORE_PARKING
>  	bool
>  
>  config GRANT_TABLE
> -	bool "Grant table support" if EXPERT
> +	bool "Grant table support (EXPERT)" if EXPERT
>  	default y

... like e.g. here, it's only the prompt that's conditional. IOW
like with the respective uses of UNSUPPORTED in some of the Arm
changes in patch 1, especially when the option's default is "yes"
it's not the feature that is an expert one, but its turning off
is considered an expert change. Which I don't think should be
expressed this way.

Jan
Bertrand Marquis Jan. 26, 2021, 11:08 a.m. UTC | #2
Hi,

> On 25 Jan 2021, at 21:27, Stefano Stabellini <sstabellini@kernel.org> wrote:
> 
> Add an "(EXPERT)" tag to the one-line description of Kconfig options
> that depend on EXPERT.
> 
> Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
> CC: andrew.cooper3@citrix.com
> CC: george.dunlap@citrix.com
> CC: iwj@xenproject.org
> CC: jbeulich@suse.com
> CC: julien@xen.org
> CC: wl@xen.org

Reviewed-by: Bertrand Marquis <bertrand.marquis@arm.com>

Cheers
Bertrand

> 
> ---
> Changes in v4:
> - new patch
> ---
> xen/arch/x86/Kconfig     |  2 +-
> xen/common/Kconfig       | 12 ++++++------
> xen/common/sched/Kconfig |  2 +-
> 3 files changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/xen/arch/x86/Kconfig b/xen/arch/x86/Kconfig
> index 302334d3e4..3f630b89e8 100644
> --- a/xen/arch/x86/Kconfig
> +++ b/xen/arch/x86/Kconfig
> @@ -103,7 +103,7 @@ config HVM
> 	  If unsure, say Y.
> 
> config XEN_SHSTK
> -	bool "Supervisor Shadow Stacks"
> +	bool "Supervisor Shadow Stacks (EXPERT)"
> 	depends on HAS_AS_CET_SS && EXPERT
> 	default y
> 	---help---
> diff --git a/xen/common/Kconfig b/xen/common/Kconfig
> index 39451e8350..b49127463d 100644
> --- a/xen/common/Kconfig
> +++ b/xen/common/Kconfig
> @@ -12,7 +12,7 @@ config CORE_PARKING
> 	bool
> 
> config GRANT_TABLE
> -	bool "Grant table support" if EXPERT
> +	bool "Grant table support (EXPERT)" if EXPERT
> 	default y
> 	---help---
> 	  Grant table provides a generic mechanism to memory sharing
> @@ -151,7 +151,7 @@ config KEXEC
> 	  If unsure, say Y.
> 
> config EFI_SET_VIRTUAL_ADDRESS_MAP
> -    bool "EFI: call SetVirtualAddressMap()" if EXPERT
> +    bool "EFI: call SetVirtualAddressMap() (EXPERT)" if EXPERT
>     ---help---
>       Call EFI SetVirtualAddressMap() runtime service to setup memory map for
>       further runtime services. According to UEFI spec, it isn't strictly
> @@ -162,7 +162,7 @@ config EFI_SET_VIRTUAL_ADDRESS_MAP
> 
> config XENOPROF
> 	def_bool y
> -	prompt "Xen Oprofile Support" if EXPERT
> +	prompt "Xen Oprofile Support (EXPERT)" if EXPERT
> 	depends on X86
> 	---help---
> 	  Xen OProfile (Xenoprof) is a system-wide profiler for Xen virtual
> @@ -199,7 +199,7 @@ config XSM_FLASK
> 
> config XSM_FLASK_AVC_STATS
> 	def_bool y
> -	prompt "Maintain statistics on the FLASK access vector cache" if EXPERT
> +	prompt "Maintain statistics on the FLASK access vector cache (EXPERT)" if EXPERT
> 	depends on XSM_FLASK
> 	---help---
> 	  Maintain counters on the access vector cache that can be viewed using
> @@ -344,7 +344,7 @@ config SUPPRESS_DUPLICATE_SYMBOL_WARNINGS
> 	  build becoming overly verbose.
> 
> config CMDLINE
> -	string "Built-in hypervisor command string" if EXPERT
> +	string "Built-in hypervisor command string (EXPERT)" if EXPERT
> 	default ""
> 	---help---
> 	  Enter arguments here that should be compiled into the hypervisor
> @@ -377,7 +377,7 @@ config DOM0_MEM
> 	  Leave empty if you are not sure what to specify.
> 
> config TRACEBUFFER
> -	bool "Enable tracing infrastructure" if EXPERT
> +	bool "Enable tracing infrastructure (EXPERT)" if EXPERT
> 	default y
> 	---help---
> 	  Enable tracing infrastructure and pre-defined tracepoints within Xen.
> diff --git a/xen/common/sched/Kconfig b/xen/common/sched/Kconfig
> index 94c9e20139..b6020a83c6 100644
> --- a/xen/common/sched/Kconfig
> +++ b/xen/common/sched/Kconfig
> @@ -1,4 +1,4 @@
> -menu "Schedulers"
> +menu "Schedulers (EXPERT)"
> 	visible if EXPERT
> 
> config SCHED_CREDIT
> -- 
> 2.17.1
> 
>
Stefano Stabellini Jan. 26, 2021, 6:36 p.m. UTC | #3
On Tue, 26 Jan 2021, Jan Beulich wrote:
> On 25.01.2021 22:27, Stefano Stabellini wrote:
> > --- a/xen/arch/x86/Kconfig
> > +++ b/xen/arch/x86/Kconfig
> > @@ -103,7 +103,7 @@ config HVM
> >  	  If unsure, say Y.
> >  
> >  config XEN_SHSTK
> > -	bool "Supervisor Shadow Stacks"
> > +	bool "Supervisor Shadow Stacks (EXPERT)"
> >  	depends on HAS_AS_CET_SS && EXPERT
> >  	default y
> >  	---help---
> 
> I agree with this addition, but I'm afraid I'm at least uncertain
> about all the other ones made here, where ...
> 
> > --- a/xen/common/Kconfig
> > +++ b/xen/common/Kconfig
> > @@ -12,7 +12,7 @@ config CORE_PARKING
> >  	bool
> >  
> >  config GRANT_TABLE
> > -	bool "Grant table support" if EXPERT
> > +	bool "Grant table support (EXPERT)" if EXPERT
> >  	default y
> 
> ... like e.g. here, it's only the prompt that's conditional. IOW
> like with the respective uses of UNSUPPORTED in some of the Arm
> changes in patch 1, especially when the option's default is "yes"
> it's not the feature that is an expert one, but its turning off
> is considered an expert change. Which I don't think should be
> expressed this way.

That's a good point actually. It makes sense to add the EXPERT tag to
the one-line description of options that depends on EXPERT. Not where
only the prompt depends on EXPERT and the option is actually default y.

Which really narrows it down to XEN_SHSTK only. I'll reduce the patch
to do just that.
diff mbox series

Patch

diff --git a/xen/arch/x86/Kconfig b/xen/arch/x86/Kconfig
index 302334d3e4..3f630b89e8 100644
--- a/xen/arch/x86/Kconfig
+++ b/xen/arch/x86/Kconfig
@@ -103,7 +103,7 @@  config HVM
 	  If unsure, say Y.
 
 config XEN_SHSTK
-	bool "Supervisor Shadow Stacks"
+	bool "Supervisor Shadow Stacks (EXPERT)"
 	depends on HAS_AS_CET_SS && EXPERT
 	default y
 	---help---
diff --git a/xen/common/Kconfig b/xen/common/Kconfig
index 39451e8350..b49127463d 100644
--- a/xen/common/Kconfig
+++ b/xen/common/Kconfig
@@ -12,7 +12,7 @@  config CORE_PARKING
 	bool
 
 config GRANT_TABLE
-	bool "Grant table support" if EXPERT
+	bool "Grant table support (EXPERT)" if EXPERT
 	default y
 	---help---
 	  Grant table provides a generic mechanism to memory sharing
@@ -151,7 +151,7 @@  config KEXEC
 	  If unsure, say Y.
 
 config EFI_SET_VIRTUAL_ADDRESS_MAP
-    bool "EFI: call SetVirtualAddressMap()" if EXPERT
+    bool "EFI: call SetVirtualAddressMap() (EXPERT)" if EXPERT
     ---help---
       Call EFI SetVirtualAddressMap() runtime service to setup memory map for
       further runtime services. According to UEFI spec, it isn't strictly
@@ -162,7 +162,7 @@  config EFI_SET_VIRTUAL_ADDRESS_MAP
 
 config XENOPROF
 	def_bool y
-	prompt "Xen Oprofile Support" if EXPERT
+	prompt "Xen Oprofile Support (EXPERT)" if EXPERT
 	depends on X86
 	---help---
 	  Xen OProfile (Xenoprof) is a system-wide profiler for Xen virtual
@@ -199,7 +199,7 @@  config XSM_FLASK
 
 config XSM_FLASK_AVC_STATS
 	def_bool y
-	prompt "Maintain statistics on the FLASK access vector cache" if EXPERT
+	prompt "Maintain statistics on the FLASK access vector cache (EXPERT)" if EXPERT
 	depends on XSM_FLASK
 	---help---
 	  Maintain counters on the access vector cache that can be viewed using
@@ -344,7 +344,7 @@  config SUPPRESS_DUPLICATE_SYMBOL_WARNINGS
 	  build becoming overly verbose.
 
 config CMDLINE
-	string "Built-in hypervisor command string" if EXPERT
+	string "Built-in hypervisor command string (EXPERT)" if EXPERT
 	default ""
 	---help---
 	  Enter arguments here that should be compiled into the hypervisor
@@ -377,7 +377,7 @@  config DOM0_MEM
 	  Leave empty if you are not sure what to specify.
 
 config TRACEBUFFER
-	bool "Enable tracing infrastructure" if EXPERT
+	bool "Enable tracing infrastructure (EXPERT)" if EXPERT
 	default y
 	---help---
 	  Enable tracing infrastructure and pre-defined tracepoints within Xen.
diff --git a/xen/common/sched/Kconfig b/xen/common/sched/Kconfig
index 94c9e20139..b6020a83c6 100644
--- a/xen/common/sched/Kconfig
+++ b/xen/common/sched/Kconfig
@@ -1,4 +1,4 @@ 
-menu "Schedulers"
+menu "Schedulers (EXPERT)"
 	visible if EXPERT
 
 config SCHED_CREDIT