From d7af4dc678176dfc2c53091b6e3f19070d5b6ee1 Mon Sep 17 00:00:00 2001 From: Claudius Heine Date: Wed, 9 Feb 2022 10:56:57 +0100 Subject: [PATCH] docs/userguide.rst: clarify local file include paths How relative paths in local file includes are handles is more complex than this one line makes out to be. This change clarifies the documentation here. Signed-off-by: Claudius Heine [Jan: dropped duplicate blank at beginning of sentence] Signed-off-by: Jan Kiszka --- docs/userguide.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/userguide.rst b/docs/userguide.rst index e4a275b..6c058f1 100644 --- a/docs/userguide.rst +++ b/docs/userguide.rst @@ -185,7 +185,13 @@ repository/layer like this: - bsp.yml - product.yml -The specified files are addressed relative to your current configuration file. +The paths to the files in the include list are either absolute, if they start +with a `/`, or relative. + +If the path is relative and the configuration file is inside a repository, +then path is relative to the repositories base directory. If the +configuration file is not in a repository, then the path is relative to the +parent directory of the file. Including configuration files from other repos ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~