diff options
| author | Klaus Aehlig <klaus.aehlig@huawei.com> | 2024-03-04 16:30:27 +0100 |
|---|---|---|
| committer | Klaus Aehlig <klaus.aehlig@huawei.com> | 2024-03-05 11:05:10 +0100 |
| commit | 444fc1fb49bde80244420dcd58e5fc26ea430fbd (patch) | |
| tree | 1ee434fb6ac6ebef995a08468f5074e257023ff3 /share | |
| parent | 9701d10ffc08d1f46ddc583b086c1939d83a79d5 (diff) | |
| download | justbuild-444fc1fb49bde80244420dcd58e5fc26ea430fbd.tar.gz | |
Update documentation, now that "foreign file" roots are implemented
Diffstat (limited to 'share')
| -rw-r--r-- | share/man/just-mr-repository-config.5.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/share/man/just-mr-repository-config.5.md b/share/man/just-mr-repository-config.5.md index 169e9a1d..97901061 100644 --- a/share/man/just-mr-repository-config.5.md +++ b/share/man/just-mr-repository-config.5.md @@ -75,6 +75,24 @@ The following fields are supported: This entry is optional. If missing, the root directory of the archive is used. +### *`"foreign file"`* + +Define a root as consisting of single file with given content at +a specific name with specified executable bit. + +The following fields are supported. + +- *`"content"`*, *`"fetch"`*, *`"distfile"`*, *`"mirrors"`*, *`"sha256"`*, + and *`"sha512"`* specify the file content in the same way as they specify + the archive content for an *`"archive"`* repository. + +- *`"name"`* specifies the name the content should have in the defined root. + It has to be a plain file name without implicitly specified sudirs. This + field is mandatory. + +- *`"executable"`* is a boolean indicating whether the fetched file should + be provided with the executable bit. Defaults to `false`. + ### *`"git"`* It defines as workspace root a part of a Git repository. |