From 1d8156b5a9dc483589fa706790cf938bd9a08a07 Mon Sep 17 00:00:00 2001 From: Paul Cristian Sarbu Date: Tue, 28 Jan 2025 15:08:48 +0100 Subject: just-lock design: Clarify wording of --clone option - specify that what is cloned is the workspace root of the target repository - disambiguate what is referred to as the 'start' and 'target' repository --- doc/future-designs/just-lock.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/future-designs/just-lock.md b/doc/future-designs/just-lock.md index e20817bf..d26ca69d 100644 --- a/doc/future-designs/just-lock.md +++ b/doc/future-designs/just-lock.md @@ -120,11 +120,12 @@ OPTIONS: --launcher JSON Local launcher to use for commands. Given as a JSON list of strings. If missing, ["env", "--"] is used. User must pass it also to `just-mr`. --clone JSON Mapping from filesystem path to pair of repository name and a list of bindings. - For each map entry, the repository found by following the bindings from the given repository, - after all repositories have been imported, will be cloned in the specified filesystem directory and - its description in the output configuration made to point to this clone. - The specified repository names must be known, i.e., an initial repository or declared import, - and both the initial and target repositories will be kept during deduplication. + For each map entry, the target repository, found by following the bindings from a given start + repository, after all repositories have been imported, will have its workspace root cloned in + the specified filesystem directory and its description in the output configuration made to + point to this clone. + The start repository names must be known, i.e., an initial repository or declared import, + and both the start and target repositories will be kept during deduplication. ``` - Notes: -- cgit v1.2.3