From: Ahmad Fatoum <a.fatoum@pengutronix.de>
To: barebox@lists.infradead.org
Cc: Casey Reeves <contact@xogium.me>, Ahmad Fatoum <a.fatoum@pengutronix.de>
Subject: [PATCH] common: clarify help text for CONFIG_CONSOLE_ACTIVATE_* options
Date: Fri, 26 Jul 2024 14:23:36 +0200 [thread overview]
Message-ID: <20240726122336.3566793-1-a.fatoum@pengutronix.de> (raw)
CONFIG_CONSOLE_ACTIVATE_NONE is an unfortunate name. The help text
explains how consoles are still activated, but omits the main way they
are activated: The device tree's /chosen/stdout-path property.
Similarly, CONFIG_CONSOLE_ACTIVATE_(FIRST/NONE) don't talk about the
implications of selecting them, so reword the help texts to better
inform the user.
Reported-by: Casey Reeves <contact@xogium.me>
Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
common/Kconfig | 18 ++++++++++++------
1 file changed, 12 insertions(+), 6 deletions(-)
diff --git a/common/Kconfig b/common/Kconfig
index 2dda5ce5743a..fea26262da86 100644
--- a/common/Kconfig
+++ b/common/Kconfig
@@ -818,9 +818,10 @@ config CONSOLE_ACTIVATE_FIRST
bool
prompt "activate first console on startup"
help
- Normally on startup all consoles are disabled, so you won't
- see anything from barebox starting. Enabling this option
- enables the first console.
+ Select this to activate the first registered console.
+ On many systems, devices are probed in no strict order,
+ so you probably should say n here if you are probing
+ from device tree and have more than one console.
config CONSOLE_ACTIVATE_ALL
bool
@@ -831,6 +832,10 @@ config CONSOLE_ACTIVATE_ALL
Only the first registered console will have the full startup
log though.
+ If you have consoles that aren't meant for barebox log output
+ (e.g. a connected MCU), you will want to say n here and use
+ CONFIG_ACTIVATE_ALL_FALLBACK or CONFIG_CONSOLE_ACTIVATE_NONE instead.
+
config CONSOLE_ACTIVATE_ALL_FALLBACK
bool
prompt "activate all consoles as fallback"
@@ -852,9 +857,10 @@ config CONSOLE_ACTIVATE_NONE
prompt "leave all consoles disabled"
bool
help
- Leave all consoles disabled on startup. Board code or environment
- is responsible for enabling a console. Otherwise you'll get a working
- barebox, you just won't see anything.
+ Leave all consoles disabled on startup. Board code, environment
+ or the device tree /chosen/stdout-path property will be responsible
+ for enabling a console. Otherwise you'll get a working barebox,
+ you just won't see anything.
endchoice
--
2.39.2
next reply other threads:[~2024-07-26 12:24 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-26 12:23 Ahmad Fatoum [this message]
2024-07-30 10:17 ` 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=20240726122336.3566793-1-a.fatoum@pengutronix.de \
--to=a.fatoum@pengutronix.de \
--cc=barebox@lists.infradead.org \
--cc=contact@xogium.me \
/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