diff options
| author | Trent Piepho <tpiepho@gmail.com> | 2021-05-18 23:01:34 -0700 |
|---|---|---|
| committer | Sascha Hauer <s.hauer@pengutronix.de> | 2021-05-25 07:49:41 +0200 |
| commit | 257680074e2a1abea196fa6df382d33eebd2fee7 (patch) | |
| tree | e4a072bc9b75178c27e16b2097a80860e4b5333e | |
| parent | 64ed9adbc24bc14586e904cadfea2d6bf11fcac2 (diff) | |
| download | barebox-257680074e2a1abea196fa6df382d33eebd2fee7.tar.gz barebox-257680074e2a1abea196fa6df382d33eebd2fee7.tar.xz | |
Documentation: Update env sources documentation
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.
Link: https://lore.barebox.org/20210519060134.2976676-1-tpiepho@gmail.com
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
| -rw-r--r-- | Documentation/user/defaultenv-2.rst | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/Documentation/user/defaultenv-2.rst b/Documentation/user/defaultenv-2.rst index da766e4edc..bf738084b2 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 |