diff mbox series

[v2,2/2] xen: update CONFIG_DEBUG_INFO help text

Message ID 20230403162823.30681-3-jgross@suse.com (mailing list archive)
State Superseded
Headers show
Series xen: some CONFIG_DEBUG_INFO changes | expand

Commit Message

Jürgen Groß April 3, 2023, 4:28 p.m. UTC
Update the help text of the CONFIG_DEBUG_INFO option to be a little
bit more specific.

Signed-off-by: Juergen Gross <jgross@suse.com>
---
V2:
- expand help text, especially mentioning INSTALL_EFI_STRIP
  (Jan Beulich)
---
 xen/Kconfig.debug | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

Comments

Jan Beulich April 4, 2023, 9:09 a.m. UTC | #1
On 03.04.2023 18:28, Juergen Gross wrote:
> --- a/xen/Kconfig.debug
> +++ b/xen/Kconfig.debug
> @@ -15,8 +15,14 @@ config DEBUG_INFO
>  	bool "Compile Xen with debug info"
>  	default DEBUG
>  	help
> -	  If you say Y here the resulting Xen will include debugging info
> -	  resulting in a larger binary image.
> +	  Say Y here if you want to build Xen with debug information. This
> +	  information is needed e.g. for doing crash dump analysis of the
> +	  hypervisor via the "crash" tool.
> +	  Saying Y will increase the size of the xen-syms and xen.efi
> +	  binaries. In case the space on the EFI boot partition is rather
> +	  limited, you may want to make use of the INSTALL_EFI_STRIP make
> +	  variable when building the hypervisor, in order to strip xen.efi
> +	  before installing it to the EFI partition.

Hmm, INSTALL_EFI_STRIP is only a courtesy to developers wanting to install
xen.efi directly into the EFI partition. It wouldn't affect the normal
flow, and hence I think this wants expressing here such that both kinds of
people have at least a hint what they need to do. I.e. in the normal case
they'd need to adjust the way xen.efi is "propagated" from its installed
location onto the EFI partition, to do the desired stripping at that time.

Jan
Jürgen Groß April 5, 2023, 11:24 a.m. UTC | #2
On 04.04.23 11:09, Jan Beulich wrote:
> On 03.04.2023 18:28, Juergen Gross wrote:
>> --- a/xen/Kconfig.debug
>> +++ b/xen/Kconfig.debug
>> @@ -15,8 +15,14 @@ config DEBUG_INFO
>>   	bool "Compile Xen with debug info"
>>   	default DEBUG
>>   	help
>> -	  If you say Y here the resulting Xen will include debugging info
>> -	  resulting in a larger binary image.
>> +	  Say Y here if you want to build Xen with debug information. This
>> +	  information is needed e.g. for doing crash dump analysis of the
>> +	  hypervisor via the "crash" tool.
>> +	  Saying Y will increase the size of the xen-syms and xen.efi
>> +	  binaries. In case the space on the EFI boot partition is rather
>> +	  limited, you may want to make use of the INSTALL_EFI_STRIP make
>> +	  variable when building the hypervisor, in order to strip xen.efi
>> +	  before installing it to the EFI partition.
> 
> Hmm, INSTALL_EFI_STRIP is only a courtesy to developers wanting to install
> xen.efi directly into the EFI partition. It wouldn't affect the normal
> flow, and hence I think this wants expressing here such that both kinds of
> people have at least a hint what they need to do. I.e. in the normal case
> they'd need to adjust the way xen.efi is "propagated" from its installed
> location onto the EFI partition, to do the desired stripping at that time.

Would you be fine with:

   In case the space on the EFI boot partition is rather
   limited, you may want to install a stripped variant of xen.efi in
   the EFI boot partition (look for "INSTALL_EFI_STRIP" in
   docs/misc/efi.pandoc for more information - when not using
   "make install-xen" for installing xen.efi, stripping needs to be
   done outside the Xen build environment).


Juergen
Jan Beulich April 5, 2023, 1:04 p.m. UTC | #3
On 05.04.2023 13:24, Juergen Gross wrote:
> On 04.04.23 11:09, Jan Beulich wrote:
>> On 03.04.2023 18:28, Juergen Gross wrote:
>>> --- a/xen/Kconfig.debug
>>> +++ b/xen/Kconfig.debug
>>> @@ -15,8 +15,14 @@ config DEBUG_INFO
>>>   	bool "Compile Xen with debug info"
>>>   	default DEBUG
>>>   	help
>>> -	  If you say Y here the resulting Xen will include debugging info
>>> -	  resulting in a larger binary image.
>>> +	  Say Y here if you want to build Xen with debug information. This
>>> +	  information is needed e.g. for doing crash dump analysis of the
>>> +	  hypervisor via the "crash" tool.
>>> +	  Saying Y will increase the size of the xen-syms and xen.efi
>>> +	  binaries. In case the space on the EFI boot partition is rather
>>> +	  limited, you may want to make use of the INSTALL_EFI_STRIP make
>>> +	  variable when building the hypervisor, in order to strip xen.efi
>>> +	  before installing it to the EFI partition.
>>
>> Hmm, INSTALL_EFI_STRIP is only a courtesy to developers wanting to install
>> xen.efi directly into the EFI partition. It wouldn't affect the normal
>> flow, and hence I think this wants expressing here such that both kinds of
>> people have at least a hint what they need to do. I.e. in the normal case
>> they'd need to adjust the way xen.efi is "propagated" from its installed
>> location onto the EFI partition, to do the desired stripping at that time.
> 
> Would you be fine with:
> 
>    In case the space on the EFI boot partition is rather
>    limited, you may want to install a stripped variant of xen.efi in
>    the EFI boot partition (look for "INSTALL_EFI_STRIP" in
>    docs/misc/efi.pandoc for more information - when not using
>    "make install-xen" for installing xen.efi, stripping needs to be
>    done outside the Xen build environment).

SGTM, thanks.

Jan
diff mbox series

Patch

diff --git a/xen/Kconfig.debug b/xen/Kconfig.debug
index e0d773d347..e6e609f813 100644
--- a/xen/Kconfig.debug
+++ b/xen/Kconfig.debug
@@ -15,8 +15,14 @@  config DEBUG_INFO
 	bool "Compile Xen with debug info"
 	default DEBUG
 	help
-	  If you say Y here the resulting Xen will include debugging info
-	  resulting in a larger binary image.
+	  Say Y here if you want to build Xen with debug information. This
+	  information is needed e.g. for doing crash dump analysis of the
+	  hypervisor via the "crash" tool.
+	  Saying Y will increase the size of the xen-syms and xen.efi
+	  binaries. In case the space on the EFI boot partition is rather
+	  limited, you may want to make use of the INSTALL_EFI_STRIP make
+	  variable when building the hypervisor, in order to strip xen.efi
+	  before installing it to the EFI partition.
 
 if DEBUG || EXPERT