mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Ahmad Fatoum <ahmad@a3f.at>
To: barebox@lists.infradead.org
Cc: Ahmad Fatoum <ahmad@a3f.at>
Subject: [PATCH] common: improve CONFIG_DEFAULT_COMPRESSION_* documentation
Date: Mon, 27 Mar 2023 08:06:52 +0200	[thread overview]
Message-ID: <20230327060652.2055761-1-ahmad@a3f.at> (raw)

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




             reply	other threads:[~2023-03-27  6:08 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-27  6:06 Ahmad Fatoum [this message]
2023-03-28  8:00 ` Sascha Hauer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230327060652.2055761-1-ahmad@a3f.at \
    --to=ahmad@a3f.at \
    --cc=barebox@lists.infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox