diff options
| -rw-r--r-- | share/man/just-import-git.1.md | 8 | ||||
| -rw-r--r-- | share/man/just-mr-repository-config.5.md | 8 | ||||
| -rw-r--r-- | share/man/just-mr.1.md | 26 | ||||
| -rw-r--r-- | share/man/just-mrrc.5.md | 4 |
4 files changed, 36 insertions, 10 deletions
diff --git a/share/man/just-import-git.1.md b/share/man/just-import-git.1.md index def3e495..4d33f488 100644 --- a/share/man/just-import-git.1.md +++ b/share/man/just-import-git.1.md @@ -82,6 +82,14 @@ for a single repository. Useful, if the repository to be imported does not have a repository configuration or should be imported without dependencies. +**`--mirror`** *`URL`* +Provides an alternative fetch location for the imported repository. +Specifying this option multiple times will accumulate URLs in the order +they appear on the command line. These URLs will not be used during the +import, but instead will be recorded as the value of the `"mirrors"` key +in the resulting configuration of the imported repository. +See **`just-mr-repository-config`**(5). + See also ======== diff --git a/share/man/just-mr-repository-config.5.md b/share/man/just-mr-repository-config.5.md index b14023a8..dcdee02f 100644 --- a/share/man/just-mr-repository-config.5.md +++ b/share/man/just-mr-repository-config.5.md @@ -59,6 +59,10 @@ The following fields are supported: This entry is optional. If missing, the basename of the fetch URL is used. + - *`"mirrors"`* is an optional list of alternative locations to try to + fetch from if contacting the main fetch location fails. This entry is + optional. + - *`"sha256"`*, - *`"sha512"`* provide optional checksum hashes in order to verify the @@ -86,6 +90,10 @@ The following fields are supported: - *`"branch"`* provides the branch name, with the promise that it contains the aforementioned commit. This entry is mandatory. + - *`"mirrors"`* is an optional list of alternative locations to try to + fetch from if contacting the main repository fails. This entry is + optional. + - *`"subdir"`* specifies the subdirectory containing the distribution files. This entry is optional. If missing, the root directory of the Git repository is used. diff --git a/share/man/just-mr.1.md b/share/man/just-mr.1.md index 5ac19a23..4c5f8713 100644 --- a/share/man/just-mr.1.md +++ b/share/man/just-mr.1.md @@ -74,14 +74,24 @@ set in the **`just-mrrc`**(5) file. Default: path *`".cache/just"`* in user's home directory. **`--checkout-locations`** *`PATH`* -Specification file for checkout locations. This file contains a JSON -object, for which under the key *`"<version control>"`* of key -*`"checkouts"`* we get pairs of repository URLs as keys and absolute -paths as values. Currently supported version control is Git, therefore -the respective key is *`"git"`*. The paths contained for each repository -URL point to existing locations on the filesystem containing the -checkout of the respective repository. This options overwrites any -values set in the **`just-mrrc`**(5) file. +Specification file for checkout locations and additional mirrors. +This file contains a JSON object with several known keys: + + - the key *`"<version control>"`* of key *`"checkouts"`* specifies + pairs of repository URLs as keys and absolute paths as values. + Currently supported version control is Git, therefore + the respective key is *`"git"`*. The paths contained for each repository + URL point to existing locations on the filesystem containing the + checkout of the respective repository. + - the key *`"local mirrors"`*, if given, is a JSON object mapping primary + URLs to a list of local (non-public) mirrors. These mirrors are always + tried first (in the given order) before any other URL is contacted. + - the key *`"preferred hostnames"`*, if given, is a list of strings + specifying known hostnames. When fetching from a non-local URL, URLs + with hostnames in the given list are preferred (in the order given) + over URLs with other hostnames. + +This options overwrites any values set in the **`just-mrrc`**(5) file. Default: file path *`".just-local.json"`* in user's home directory. **`-L`**, **`--local-launcher`** *`JSON_ARRAY`* diff --git a/share/man/just-mrrc.5.md b/share/man/just-mrrc.5.md index 5811073a..331c2eb1 100644 --- a/share/man/just-mrrc.5.md +++ b/share/man/just-mrrc.5.md @@ -60,8 +60,8 @@ The just-mrrc is given by a JSON object. details, see **`just-mr`**(1). - The value for the key *`"checkout locations"`* is a single location - object, specifying the path to the file for checkout locations. For - more details, see **`just-mr`**(1). + object, specifying the path to the file describing checkout locations + and additional mirror locations. For more details, see **`just-mr`**(1). - The value for the key *`"distdirs"`* is a JSON list of location objects, specifying where to look for distribution files (usually |