summaryrefslogtreecommitdiff
path: root/share/man/just-lock-config.5.md
diff options
context:
space:
mode:
authorPaul Cristian Sarbu <paul.cristian.sarbu@huawei.com>2025-02-17 10:05:15 +0100
committerPaul Cristian Sarbu <paul.cristian.sarbu@huawei.com>2025-02-20 15:33:53 +0100
commite749a97621d445de5e0dec89ab840dd61839d872 (patch)
tree87f5290818f07def99b0a76e6e088614c5664a91 /share/man/just-lock-config.5.md
parent377b216dea73254f8d8e37868484be69a746678a (diff)
downloadjustbuild-e749a97621d445de5e0dec89ab840dd61839d872.tar.gz
just-lock: Improve handling of pragmas in 'repos' import description
In particular, any transitive 'file'-type repository will inherit any given '{to_git: true}' pragma in the import description objects. Note that this technically can only happen for transitive 'file' repositories imported from a 'file' source, so in all other cases such a pragma would not have any effect. Document change and extend the import from 'file' source test to check this feature.
Diffstat (limited to 'share/man/just-lock-config.5.md')
-rw-r--r--share/man/just-lock-config.5.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/share/man/just-lock-config.5.md b/share/man/just-lock-config.5.md
index f90378ff..5ae901fb 100644
--- a/share/man/just-lock-config.5.md
+++ b/share/man/just-lock-config.5.md
@@ -40,16 +40,19 @@ The following fields are supported:
and its value is used instead.
- *`"map"`* has as value a JSON object with string key-value pairs defining a
- mapping between repository names that would be brought in by this import
+ mapping between repository names that would be brought in by this import
(possibly transitively) and already imported repositories. This mapping can
be used to avoid additional duplications of repositories from multiple
imports. This entry is optional.
- - *`"pragma"`* has as value a JSON object. Currently, it supports the key
- *`"absent"`* with a boolean value; if this field evaluates to `true`, it
- informs that the imported repository and all transitive repositories imported
- as a consequence should have the `{"absent": true}` pragma added to their
- description in the output configuration. This entry is optional.
+ - *`"pragma"`* has as value a JSON object. This entry is optional.
+ If the object contains the `{"absent": true}` object, it informs that the
+ imported repository and all transitive repositories imported as a
+ consequence should have the `{"absent": true}` pragma added to their
+ description.
+ If the object contains the `{"to_git": true}` object, it informs that all
+ `"file"`-type repositories brought in as a consequence of this import should
+ have the `{"to_git": true}` pragma added to their description.
Source objects
--------------