summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPaul Cristian Sarbu <paul.cristian.sarbu@huawei.com>2023-11-09 15:42:58 +0100
committerPaul Cristian Sarbu <paul.cristian.sarbu@huawei.com>2023-11-14 13:35:01 +0100
commit5c9ea8725ebb58d42956309e7995e08837a25ff4 (patch)
tree8b8f6f165602e2440c9ef716543d4a90f9851d37 /doc
parenta987adcbb97f878698018c1ec73536ad9bc2dcac (diff)
downloadjustbuild-5c9ea8725ebb58d42956309e7995e08837a25ff4.tar.gz
alternative-mirrors design doc: Move to concepts folder
...and reword content to move from proposal to implemented state.
Diffstat (limited to 'doc')
-rw-r--r--doc/concepts/alternative-mirrors.md (renamed from doc/future-designs/alternative-mirrors.md)16
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/future-designs/alternative-mirrors.md b/doc/concepts/alternative-mirrors.md
index 9839572d..5572eda9 100644
--- a/doc/future-designs/alternative-mirrors.md
+++ b/doc/concepts/alternative-mirrors.md
@@ -1,5 +1,5 @@
-Alternative Mirrors Proposal
-============================
+Alternative Mirrors
+===================
Background
----------
@@ -23,17 +23,17 @@ to continue the project independent of the dependencies' upstream.
It is therefore desirable that `just-mr` support this workflow while
still clearly pointing out the upstream location, e.g., for updating.
-Proposal
---------
+Implementation
+--------------
-We propose the following, backwards-compatible, extensions to
+We have introduced the following, backwards-compatible, extensions to
`just-mr`.
### Mirrors field in `just-mr` repository config
In the multi-repository configuration, in the definition of an
`"archive"`, `"zip"` or `"git"` repository, an addition field
-`"mirrors"` can be added. If given, this field has to be a list
+`"mirrors"` was added. If given, this field has to be a list
of URLs that provide additional places where the respective
repository can be fetched from. `just-mr` will only consider a fetch
failed if the repository cannot be fetched neither from the main
@@ -47,7 +47,7 @@ Local mirrors of organizations are often not available to the
general public and possibly not even available to everyone who
has access to the respective project. In order to avoid polluting
a multi-repository specification with the URLs of such restricted
-mirrors, the `.just-local` file is extended to support additional
+mirrors, the `.just-local` file was extended to support additional
keys in its JSON object.
- For the optional key `"local mirrors"`, if given, a JSON object
is specified that maps primary URLs to a list of local (non-public)
@@ -64,7 +64,7 @@ keys in its JSON object.
As multi-repository specifications are often generated from a
description of the local repositories by a chain of `just-import-git`
invocations, this tool needs to be able to also insert a `"mirrors"`
-field for the repository imported. Therefore, this tool will be
+field for the repository imported. Therefore, this tool was
extended by an option `--mirror` where multiple occurrences accumulate
to specify additional mirrors for the URL fetched. These mirrors,
if any, form the `"mirrors"` field of the repository imported; they