mail archive of the barebox mailing list
 help / color / mirror / Atom feed
* [PATCH] common: improve CONFIG_DEFAULT_COMPRESSION_* documentation
@ 2023-03-27  6:06 Ahmad Fatoum
  2023-03-28  8:00 ` Sascha Hauer
  0 siblings, 1 reply; 2+ messages in thread
From: Ahmad Fatoum @ 2023-03-27  6:06 UTC (permalink / raw)
  To: barebox; +Cc: Ahmad Fatoum

This option is only relevant to non-PBL configurations and the
description is a bit confusing, because the default environment
is the only in-barebox binary this option compressed.

Use "built-in environment" instead of "in-barebox binaries" or "default
environment" to make this clearer.

Signed-off-by: Ahmad Fatoum <ahmad@a3f.at>
---
 common/Kconfig | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/common/Kconfig b/common/Kconfig
index 57fe5f7886de..d90b5fb88682 100644
--- a/common/Kconfig
+++ b/common/Kconfig
@@ -863,7 +863,7 @@ config DEFAULT_ENVIRONMENT
 	  CONFIG_ENV_HANDLING is not enabled.
 
 choice
-	prompt "default compression for in-barebox binaries"
+	prompt "default compression for built-in environment"
 	default DEFAULT_COMPRESSION_NONE if PBL_IMAGE
 	default DEFAULT_COMPRESSION_LZO if LZO_DECOMPRESS
 	default DEFAULT_COMPRESSION_XZ if XZ_DECOMPRESS
@@ -872,9 +872,13 @@ choice
 	default DEFAULT_COMPRESSION_BZIP2 if BZLIB
 	help
 	  For barebox builds without a prebootloader, select here the default
-	  compression for in-barebox binary files. barebox itself can't be
-	  compressed without a prebootloader, but for example the default
-	  environment will be compressed with this compression type.
+	  compression for the built-in environment. barebox itself can't be
+	  compressed without a prebootloader, but the built-in environment,
+	  including any binary files placed in it (e.g. in /env/data)
+	  will be compressed with this compression type.
+
+	  For barebox builds _with_ a prebootloader, the environment is
+	  compressed as part of barebox proper (CONFIG_IMAGE_COMPRESSION).
 
 config DEFAULT_COMPRESSION_GZIP
 	bool "gzip"
-- 
2.38.3




^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2023-03-28  8:02 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-03-27  6:06 [PATCH] common: improve CONFIG_DEFAULT_COMPRESSION_* documentation Ahmad Fatoum
2023-03-28  8:00 ` Sascha Hauer

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox