From 3ce8580a1481372cbd411b6e25d7ce6a10dcb8c2 Mon Sep 17 00:00:00 2001 From: Chris Reed Date: Thu, 17 Jul 2025 12:55:47 -0500 Subject: [PATCH 1/3] docs: fix several issues with table formatting Fixes: 2392554 ("git: Add support for project cache directory") Fixes: 61945f5 ("config: Add ${param:packagedir} to the run variables") Fixes: 4f56d55 ("config: Add btvars to yaml schema") Signed-off-by: Chris Reed --- documentation/userguide/configmodel.rst | 6 +++--- documentation/userguide/quickstart.rst | 12 ++++++------ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/documentation/userguide/configmodel.rst b/documentation/userguide/configmodel.rst index 3d8ed94..5753e98 100644 --- a/documentation/userguide/configmodel.rst +++ b/documentation/userguide/configmodel.rst @@ -129,12 +129,11 @@ macro scope ``${param:builddir}`` build..{params, prebuild, build, postbuild, artifacts} Directory in which the component should be built, if the component's build system supports separation of source and build trees. ``${param:configdir}`` build..{params, prebuild, build, postbuild, artifacts} Directory containing the config store. This MUST only be used for resolving files that already exist in the store. ``${param:jobs}`` build..{params, prebuild, build, postbuild, artifacts} Maximum number of low level parallel jobs specified on the command line. To be passed to (e.g.) make as ``-j${param:jobs}``. -``${btvar:}`` build..{sourcedir, builddir, repo, toolchain, params, prebuild, build, postbuild, artifacts}, run.rtvars Build-time variables. The variable names, along with default values are declared in buildex.btvars, and the user may override the value on the command line. +``${btvar:}`` build..{sourcedir, builddir, repo, toolchain, params, prebuild, build, postbuild, artifacts}, run.rtvars Build-time variables. The variable names, along with default values are declared in buildex.btvars, and the user may override the value on the command line. ``${param:join_equal}`` build..{prebuild, build, postbuild} String containing all of the component's parameters (from its params dictionary), concatenated as ``key=value`` pairs. ``${param:join_space}`` build..{prebuild, build, postbuild} String containing all of the component's parameters (from its params dictionary), concatenated as ``key value`` pairs. ``${artifact:}`` build..{params, prebuild, build, postbuild, artifacts}, build.btvars Build path of an artifact declared by another component. Usage of these macros determine the component build dependency graph. -``${param:packagedir}`` run.rtvars - Root directory containing all component artifacts. +``${param:packagedir}`` run.rtvars Root directory containing all component artifacts. ``${artifact:}`` run.rtvars Package path of an artifact. ``${rtvar:}`` run.params Run-time variables. The variable names, along with default values are declared in run.rtvars, and the user may override the value on the command line. ======================= ===================================================================================================================== ==== @@ -222,6 +221,7 @@ key type description remote string Address of the remote repository revision string A git revision (branch name, tag, hash...) project string Optional. Name of the project corresponding to this repository, used to retrieve a cached repository in SHRINKWRAP_PROJECT_CACHE. By default, the project name is the base name contained in the remote address. +=========== =========== =========== ----------- run section diff --git a/documentation/userguide/quickstart.rst b/documentation/userguide/quickstart.rst index f21b6bc..9c13b8f 100644 --- a/documentation/userguide/quickstart.rst +++ b/documentation/userguide/quickstart.rst @@ -73,13 +73,13 @@ Optional Environment Variables Shrinkwrap consumes the following set of optional environment variables: ========================= ===================== ==== -name default description +name default description +========================= ===================== ==== +SHRINKWRAP_CONFIG Colon-separated list of paths to config stores. Configs are searched for relative to the current directory as well as relative to these paths. +SHRINKWRAP_BUILD ~/.shrinkwrap/build Location where config builds are performed. Each config has its own subdirectory, with further subdirectories for each of its components. +SHRINKWRAP_PACKAGE ~/.shrinkwrap/package Location where config builds are packaged to. When running a config, it is done from the package location. +SHRINKWRAP_PROJECT_CACHE Location where cache repositories are stored. This directory contains git trees used as reference when downloading components, allowing to reduce network usage and local storage if the same project is used multiple times. Cache directories ending in ".git" are bare repositories, and ones without the suffix are full repositories. By default no cache is used. ========================= ===================== ==== -SHRINKWRAP_CONFIG Colon-separated list of paths to config stores. Configs are searched for relative to the current directory as well as relative to these paths. -SHRINKWRAP_BUILD ~/.shrinkwrap/build Location where config builds are performed. Each config has its own subdirectory, with further subdirectories for each of its components. -SHRINKWRAP_PACKAGE ~/.shrinkwrap/package Location where config builds are packaged to. When running a config, it is done from the package location. -SHRINKWRAP_PROJECT_CACHE Location where cache repositories are stored. This directory contains git trees used as reference when downloading components, allowing to reduce network usage and local storage if the same project is used multiple times. Cache directories ending in ".git" are bare repositories, and ones without the suffix are full repositories. By default no cache is used. -======================== ===================== ==== *************************************************** Guided Tour: Configure a platform and boot a kernel -- GitLab From 2a9ac545a26edf5d4d1c79fce8f58cbffeacffc1 Mon Sep 17 00:00:00 2001 From: Chris Reed Date: Thu, 17 Jul 2025 12:56:16 -0500 Subject: [PATCH 2/3] docs: remove userguide/configstore/assets.rst Fixes: 712d89e ("docs: Add configstore docs for newly added configs") Signed-off-by: Chris Reed --- .../userguide/configstore/assets.rst | 35 ------------------- 1 file changed, 35 deletions(-) delete mode 100644 documentation/userguide/configstore/assets.rst diff --git a/documentation/userguide/configstore/assets.rst b/documentation/userguide/configstore/assets.rst deleted file mode 100644 index 310b8a3..0000000 --- a/documentation/userguide/configstore/assets.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. - # Copyright (c) 2023, Arm Limited. - # - # SPDX-License-Identifier: MIT - -########### -assets.yaml -########### - -Description -########### - -Generation of asset images for testing. This config can be used to build the assets required to run the test script. It builds 1. Buildroot based rootfs that automatically invokes `poweroff -f` 2. Linux kernel image 3. Bootwrapper image - -Concrete -######## - -True - -Build-Time Variables -#################### - -===== ======= -btvar default -===== ======= -===== ======= - -Run-Time Variables -################## - -===== ======= -rtvar default -===== ======= -===== ======= - -- GitLab From b3cfdd6f235021cfd56ebd015952e1dcbfb18f9e Mon Sep 17 00:00:00 2001 From: Chris Reed Date: Fri, 18 Jul 2025 09:57:26 -0500 Subject: [PATCH 3/3] ci: delete docs configstore before diff Delete documentation/userguide/configstore/ contents before diffing with the genconfigstore.py output, to detect deletions in addition to changes. Signed-off-by: Chris Reed --- .gitlab-ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 59097f8..7ac1fc5 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -88,6 +88,7 @@ build-documentation: - export PATH=$PWD/shrinkwrap:$PATH - export SHRINKWRAP_BUILD=$PWD/shrinkwrap_workspace - export SHRINKWRAP_PACKAGE=$PWD/shrinkwrap_workspace/package + - rm -rf ./documentation/userguide/configstore/* - ./documentation/_scripts/genconfigstore.py - | if ! git diff --quiet; then -- GitLab