mail archive of the barebox mailing list
 help / color / mirror / Atom feed
* [PATCH v2] Documentation: reboot-mode: add note about /env/bmode
@ 2021-09-22  9:15 Ahmad Fatoum
  2021-10-01 13:25 ` Sascha Hauer
  0 siblings, 1 reply; 2+ messages in thread
From: Ahmad Fatoum @ 2021-09-22  9:15 UTC (permalink / raw)
  To: barebox; +Cc: jbe, Ahmad Fatoum

This directory is an optional part of the defaultenv-2 and
is documented there. There should be a sentence about it in
the reboot-mode docs as well, because users can add it to
their environments as well to avoid doing if-else chains
in the init scripts.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
v1 -> v2:
  - hands where on autopilot.. s/directly/directory/
---
 Documentation/user/defaultenv-2.rst | 2 +-
 Documentation/user/reboot-mode.rst  | 4 +++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/Documentation/user/defaultenv-2.rst b/Documentation/user/defaultenv-2.rst
index bf738084b2e4..a01a70fa9310 100644
--- a/Documentation/user/defaultenv-2.rst
+++ b/Documentation/user/defaultenv-2.rst
@@ -149,6 +149,6 @@ there will be a file ``eth0`` with a content like this:
 -----------
 
 This contains the files to be sourced when barebox detects that the OS
-had requested a specific reboot mode (via e.g. ``reboot bootloader``
+had requested a specific :ref:`reboot_mode` (via e.g. ``reboot bootloader``
 under Linux). After the ``/env/init`` scripts were executed, barebox will
 ``source /env/bmode/${global.system.reboot_mode.prev}`` if available.
diff --git a/Documentation/user/reboot-mode.rst b/Documentation/user/reboot-mode.rst
index 8717e3934206..507d6feb0141 100644
--- a/Documentation/user/reboot-mode.rst
+++ b/Documentation/user/reboot-mode.rst
@@ -44,7 +44,9 @@ the device. By convention, this should end with ``.reboot_mode``, e.g.::
 
 Reboot mode providers have priorities. The provider with the highest
 priority has its parameters aliased as ``$global.system.reboot_mode.prev``
-and ``$global.system.reboot_mode.next``.
+and ``$global.system.reboot_mode.next``. After executing the init scripts,
+barebox startup will ``source /env/bmode/${global.system.reboot_mode.prev}``
+if available.
 
 Reset
 =====
-- 
2.30.2


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


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

end of thread, other threads:[~2021-10-01 13:27 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-09-22  9:15 [PATCH v2] Documentation: reboot-mode: add note about /env/bmode Ahmad Fatoum
2021-10-01 13:25 ` Sascha Hauer

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