mail archive of the barebox mailing list
 help / color / mirror / Atom feed
* [PATCH] Documentation: Update env sources documentation
@ 2021-05-19  6:01 Trent Piepho
  2021-05-25  4:59 ` Sascha Hauer
  0 siblings, 1 reply; 2+ messages in thread
From: Trent Piepho @ 2021-05-19  6:01 UTC (permalink / raw)
  To: barebox; +Cc: Trent Piepho

Add CONFIG_DEFAULT_ENVIRONMENT_PATH to the list in the proper place.

Update the board env to follow the new pattern for naming and note that,
unlike the other directories, one must add code to get this directory in
the environment.
---
 Documentation/user/defaultenv-2.rst | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/Documentation/user/defaultenv-2.rst b/Documentation/user/defaultenv-2.rst
index da766e4ed..bf738084b 100644
--- a/Documentation/user/defaultenv-2.rst
+++ b/Documentation/user/defaultenv-2.rst
@@ -19,14 +19,18 @@ All new boards should use defaultenv-2 exclusively.
 
 The default environment is composed from different directories during compilation::
 
-  defaultenv/defaultenv-2-base        -> base files
-  defaultenv/defaultenv-2-dfu         -> overlay for DFU
-  defaultenv/defaultenv-2-reboot-mode -> overlay for reboot modes
-  defaultenv/defaultenv-2-menu        -> overlay for menus
-  arch/$ARCH/boards/<board>/env       -> board specific overlay
+  defaultenv/defaultenv-2-base                 -> base files
+  defaultenv/defaultenv-2-dfu                  -> overlay for DFU
+  defaultenv/defaultenv-2-reboot-mode          -> overlay for reboot modes
+  defaultenv/defaultenv-2-menu                 -> overlay for menus
+  arch/$ARCH/boards/<board>/defaultenv-<board> -> board specific overlay
+  $(CONFIG_DEFAULT_ENVIRONMENT_PATH)           -> config specific overlay
 
 The content of the above directories is applied one after another. If the
-same file exists in a later overlay, it will overwrite the preceding one.
+same file exists in a later overlay, it will overwrite the preceding one.  The
+board specific overlay, or overlays, could be at any path, but usually follows
+the form given.  They must be added to a Makefile in ``bbenv-y`` and
+``defaultenv_append_directory()`` used to add them in board init code.
 
 Note that not all of the above directories will necessarily be
 included in your default environment, it depends on your barebox
-- 
2.26.2


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


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

* Re: [PATCH] Documentation: Update env sources documentation
  2021-05-19  6:01 [PATCH] Documentation: Update env sources documentation Trent Piepho
@ 2021-05-25  4:59 ` Sascha Hauer
  0 siblings, 0 replies; 2+ messages in thread
From: Sascha Hauer @ 2021-05-25  4:59 UTC (permalink / raw)
  To: Trent Piepho; +Cc: barebox

On Tue, May 18, 2021 at 11:01:34PM -0700, Trent Piepho wrote:
> Add CONFIG_DEFAULT_ENVIRONMENT_PATH to the list in the proper place.
> 
> Update the board env to follow the new pattern for naming and note that,
> unlike the other directories, one must add code to get this directory in
> the environment.
> ---
>  Documentation/user/defaultenv-2.rst | 16 ++++++++++------
>  1 file changed, 10 insertions(+), 6 deletions(-)

Applied, thanks

Sascha


-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
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-05-25  5:00 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-19  6:01 [PATCH] Documentation: Update env sources documentation Trent Piepho
2021-05-25  4:59 ` Sascha Hauer

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