mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Roland Hieber <rhi@pengutronix.de>
To: Barebox Mailing List <barebox@lists.infradead.org>
Cc: Roland Hieber <rhi@pengutronix.de>
Subject: [PATCH] common: Kconfig: improve defaultenv help texts
Date: Thu, 28 Jan 2021 22:00:22 +0100	[thread overview]
Message-ID: <20210128210022.31841-1-rhi@pengutronix.de> (raw)

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 common/Kconfig | 28 ++++++++++++++++++++++------
 1 file changed, 22 insertions(+), 6 deletions(-)

diff --git a/common/Kconfig b/common/Kconfig
index b350f5c355fa..c62c70fb27eb 100644
--- a/common/Kconfig
+++ b/common/Kconfig
@@ -874,6 +874,13 @@ config DEFAULT_ENVIRONMENT_GENERIC_NEW
 	select NET_CMD_IFUP if NET
 	select CMD_IP_ROUTE_GET if NET
 	select CMD_HOST if NET
+	help
+	  With this option barebox will use the files found under
+	  defaultenv/defaultenv-2-base/ in the source tree as a template for
+	  the defaultenv. The directories specified in DEFAULT_ENVIRONMENT_PATH
+	  will be added to the default environment. If a file is present in
+	  both locations, the file from DEFAULT_ENVIRONMENT_PATH will overwrite
+	  that from the template.
 
 config DEFAULT_ENVIRONMENT_GENERIC
 	bool "Generic environment template (old version)"
@@ -887,9 +894,12 @@ config DEFAULT_ENVIRONMENT_GENERIC
 	select CMD_CRC_CMP
 	select CMD_GLOBAL
 	help
-	  With this option barebox will use the generic default
-	  environment found under defaultenv/ in the src tree.
-	  The Directory given with DEFAULT_ENVIRONMENT_PATH
+	  Note: this option is not recommended for new boards; use
+	  DEFAULT_ENVIRONMENT_GENERIC_NEW instead.
+
+	  With this option barebox will use the old generic default environment
+	  found under defaultenv/defaultenv-1/ in the source tree.
+	  The directory given with DEFAULT_ENVIRONMENT_PATH
 	  will be added to the default environment. This should
 	  at least contain a /env/config file.
 	  This will be able to overwrite the files from defaultenv.
@@ -899,21 +909,27 @@ config DEFAULT_ENVIRONMENT_GENERIC_NEW_MENU
 	depends on DEFAULT_ENVIRONMENT_GENERIC_NEW
 	depends on CMD_MENUTREE
 	default y
+	help
+	  Extend the defaultenv template with a menu that is displayed at boot.
+	  The menu files are taken from defaultenv/defaultenv-2-menu/.
 
 config DEFAULT_ENVIRONMENT_GENERIC_NEW_DFU
 	bool
 	depends on DEFAULT_ENVIRONMENT_GENERIC_NEW
 	depends on USB_GADGET_DFU
 	default y
+	help
+	  Extend the defaultenv template with the 'dfu' boot entry, which
+	  allows uploading the kernel and oftree over USB via the dfu protocol.
 
 config DEFAULT_ENVIRONMENT_PATH
 	string
 	depends on DEFAULT_ENVIRONMENT
 	prompt "Default environment path"
 	help
-	  Space separated list of paths the default environment will be taken from.
-	  Relative paths will be relative to the barebox Toplevel dir, but absolute
-	  paths are fine as well.
+	  Space separated list of paths from which the default environment will
+	  be taken. Relative paths will be relative to the barebox top-level
+	  directory, but absolute paths are fine as well.
 
 config BAREBOXENV_TARGET
 	bool
-- 
2.30.0


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

             reply	other threads:[~2021-01-28 21:00 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-28 21:00 Roland Hieber [this message]
2021-02-01  8:39 ` 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=20210128210022.31841-1-rhi@pengutronix.de \
    --to=rhi@pengutronix.de \
    --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