From b5f562019b21e11253b3bac348f213a95240fb79 Mon Sep 17 00:00:00 2001 From: Paul Cristian Sarbu Date: Thu, 28 Nov 2024 18:13:08 +0100 Subject: just-lock design: Clarify I/O file location defaults --- doc/future-designs/just-lock.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/future-designs/just-lock.md b/doc/future-designs/just-lock.md index dd0aa19f..f036a0c2 100644 --- a/doc/future-designs/just-lock.md +++ b/doc/future-designs/just-lock.md @@ -108,8 +108,10 @@ just-lock [-C ] [-o ] [--clone ] OPTIONS: - -C PATH Input file. If missing, searched in ['./repos.in.json', './etc/repos.in.json']. - -o PATH Output file. If missing, placed as 'repos.json' in parent path of input file. + -C PATH Input file. If missing, searched for in ['repos.in.json', 'etc/repos.in.json'] + with respect to the workspace root. + -o PATH Output file. If missing, searched for in ['repos.json', 'etc/repos.json'] with respect to + the workspace root. If none found, placed as 'repos.json' in parent path of input file. --local-build-root PATH Local build root. Usual `just-mr` rules apply. --git PATH Git binary to use if needed. If missing, system `git` is used. @@ -126,6 +128,12 @@ OPTIONS: The proposed default naming choice for the input file is chosen to mirror the default names of the configuration file of `just-mr`. + The proposed search locations for the output configuration file, if an + explicit path is not provided, are the same ones used by `just-mr` when run + with the `--norc` option, but limited to the ones relative to the workspace + root. This is done to better match the desired lock-file quality of the + output file and also ensure `just-mr` can pick it up by default. + The `--clone` option will produce an output configuration file meant for local development only. Therefore, it is not recommended for such a configuration file to be committed. -- cgit v1.2.3