diff options
| -rw-r--r-- | share/man/just-import-git.1.md | 8 | ||||
| -rw-r--r-- | share/man/just-mr.1.md | 22 | ||||
| -rw-r--r-- | share/man/just-repository-config.5.md | 2 | ||||
| -rw-r--r-- | share/man/just.1.md | 44 |
4 files changed, 40 insertions, 36 deletions
diff --git a/share/man/just-import-git.1.md b/share/man/just-import-git.1.md index be746655..c93bda4d 100644 --- a/share/man/just-import-git.1.md +++ b/share/man/just-import-git.1.md @@ -54,7 +54,7 @@ Use the specified file as the configuration to import into. The string `-` is treated as a request to take the config from stdin; so a file called `-` has to be described as `./-`, or similar. If not specified, for a config file is searched in the same way, as `just-mr` does, when -invoved with `--norc`. +invoved with **`--norc`**. **`-h`**, **`--help`** Output a usage message and exit. @@ -70,9 +70,9 @@ compatible repository already exists in the configuration. Use the file, specified by path relative to the repository root, as multi-repository specification in the imported repository. If not specifed, for a config file is searched in the same way as `just-mr` -does, when invoked with `--no-rc`, however leaving out searches relative -to global roots (`"home"` and `"system"`). In other words, `repos.json` -and `etc/repos.json` are tried if this option is not given. +does, when invoked with **`--no-rc`**, however leaving out searches +relative to global roots (`"home"` and `"system"`). In other words, +`repos.json` and `etc/repos.json` are tried if this option is not given. **`--plain`** Pretend the foreign multi-repository specification is the canonical one diff --git a/share/man/just-mr.1.md b/share/man/just-mr.1.md index 04acc7dc..af5cd888 100644 --- a/share/man/just-mr.1.md +++ b/share/man/just-mr.1.md @@ -10,8 +10,8 @@ SYNOPSIS ======== just-mr \[OPTIONS\] mrversion -just-mr \[OPTIONS\] {setup|setup-env} \[--all\] \[main-repo\] -just-mr \[OPTIONS\] fetch \[--all\] \[-o fetch-dir\] \[main-repo\] +just-mr \[OPTIONS\] {setup|setup-env} \[**`--all`**\] \[main-repo\] +just-mr \[OPTIONS\] fetch \[**`--all`**\] \[**`-o`** fetch-dir\] \[main-repo\] just-mr \[OPTIONS\] update \[repo...\] just-mr \[OPTIONS\] do \[JUST ARGS\] just-mr \[OPTIONS\] @@ -158,7 +158,7 @@ command line, only it and its dependencies are considered in the generation of the resulting multi-repository configuration file. If no main repository is provided, the lexicographical first repository from the configuration is used. To perform the setup for all repositories -from the input configuration file, use the `--all` flag. +from the input configuration file, use the **`--all`** flag. The behavior of the two subcommands differs only with respect to the main repository. In the case of `setup-env`, the workspace root of the @@ -182,13 +182,14 @@ If a main repository is provided in the input configuration or on command line, only it and its dependencies are considered for fetching. If no main repository is provided, the lexicographical first repository from the configuration is used. To perform the fetch for all -repositories from the input configuration file, use the `--all` flag. +repositories from the input configuration file, use the **`--all`** +flag. By default the first existing distribution directory is used as the output directory for writing the fetched archives on disk. If no existing distribution directory can be found an error is produced. To define an output directory that is independent of the given distribution -directories, use the `-o` option. +directories, use the **`-o`** option. update ------ @@ -221,12 +222,13 @@ provided, the lexicographical first repository from the configuration is used. All logging arguments given to `just-mr` are passed to `just` as early -arguments. If log files are provided, an unconditional `--log-append` -argument is passed as well, which ensures no log messages will get -overwritten. +arguments. If log files are provided, an unconditional +**`--log-append`** argument is passed as well, which ensures no log +messages will get overwritten. -The `--local-launcher` argument is passed to `just` as early argument -for those *known* subcommands that accept it (build, install, rebuild). +The **`--local-launcher`** argument is passed to `just` as early +argument for those *known* subcommands that accept it (build, install, +rebuild). version|describe|analyse|build|install|install-cas|rebuild|gc -------------------------------------------------------------------- diff --git a/share/man/just-repository-config.5.md b/share/man/just-repository-config.5.md index e57394e9..72f0fdcd 100644 --- a/share/man/just-repository-config.5.md +++ b/share/man/just-repository-config.5.md @@ -84,7 +84,7 @@ keys: - `"main"` contains a string, which defines the repository name to consider by default if not explicitly specified on the command line - (i.e., via `--main`). This entry is optional and if omitted the + (i.e., via **`--main`**). This entry is optional and if omitted the empty string is used. - `"repositories"` contains a JSON object that defines all diff --git a/share/man/just.1.md b/share/man/just.1.md index dabf7b2e..4417ad77 100644 --- a/share/man/just.1.md +++ b/share/man/just.1.md @@ -10,11 +10,11 @@ SYNOPSIS just version just {analyse|build} \[OPTIONS\] \[\[module\] target\] -just install -o OUTPUT_DIR \[OPTIONS\] \[\[module\] target\] +just install **`-o`** OUTPUT_DIR \[OPTIONS\] \[\[module\] target\] just install-cas \[OPTIONS\] OBJECT_ID just describe \[OPTIONS\] \[\[module\] target\] just rebuild \[OPTIONS\] \[\[module\] target\] -just traverse -g GRAPH_FILE -o OUT_DIR \[OPTIONS\] +just traverse **`-g`** GRAPH_FILE **`-o`** OUT_DIR \[OPTIONS\] just gc \[OPTIONS\] just execute \[OPTIONS\] @@ -51,18 +51,19 @@ modules. The main repository is the repository containing the target specified on the command line. The main repository can either be read from the multi-repository configuration file if it contains the key `main` or -through the option `--main`. The command-line option `--main` overrides -what is eventually read from the multi-repository configuration file. If -neither the multi-repository configuration file contains the `main` key -nor the `--main` option is provided, the lexicographical first -repository from the multi-repository configuration file is used as main. +through the option **`--main`**. The command-line option **`--main`** +overrides what is eventually read from the multi-repository +configuration file. If neither the multi-repository configuration file +contains the `main` key nor the **`--main`** option is provided, the +lexicographical first repository from the multi-repository configuration +file is used as main. The `workspace_root` of the main repository is then defined as follows. -If the option `--workspace-root` is provided, then `workspace_root` is -set accordingly. If the option is not provided, `just` checks if it is -specified within the multi-repository configuration file. If it is, then -it is set accordingly. If not, just starts looking for a marker in the -current directory first, then in all the parent directories until it +If the option **`--workspace-root`** is provided, then `workspace_root` +is set accordingly. If the option is not provided, `just` checks if it +is specified within the multi-repository configuration file. If it is, +then it is set accordingly. If not, just starts looking for a marker in +the current directory first, then in all the parent directories until it finds one. The supported markers are - ROOT file (can be empty, content is ignored) @@ -167,7 +168,7 @@ artifacts. The `install` subcommand determines which (if any) actions need to be (re)done and issues the command to (re)run them. Then, it installs the artifacts (stored in the local or remote CAS) of the processed target -under the given output-dir (set by option `-o`) honoring the logical +under the given output-dir (set by option **`-o`**) honoring the logical path (aka, staging). If the output path does not exist, it will create all the necessary folders and subfolders. If files are already present, they will be overwritten. @@ -268,8 +269,8 @@ execute This subcommand starts a single node remote execution service, honoring the just native remote protocol. -If the flag --compatible is provided, the execution service will honor -the original remote build execution protocol. +If the flag **`--compatible`** is provided, the execution service will +honor the original remote build execution protocol. OPTIONS ======= @@ -342,7 +343,7 @@ Supported by: analyse|build|describe|install|rebuild. **`--expression-root`** PATH Path of the expression files' root directory. Default: Same as ---rule-root. +**`--rule-root`**. Supported by: analyse|build|describe|install|rebuild. **`-L`**, **`--local-launcher`** JSON_ARRAY @@ -366,7 +367,8 @@ Name of the rules file. Supported by: analyse|build|describe|install|rebuild. **`--rule-root`** PATH -Path of the rule files' root directory. Default: Same as --target-root +Path of the rule files' root directory. Default: Same as +**`--target-root`** Supported by: analyse|build|describe|install|rebuild. **`--target-file-name`** TEXT @@ -375,7 +377,7 @@ Supported by: analyse|build|describe|install|rebuild. **`--target-root`** PATH Path of the target files' root directory. Default: Same as ---workspace-root +**`--workspace-root`** Supported by: analyse|build|describe|install|rebuild. **`-w`**, **`--workspace-root`** PATH @@ -468,7 +470,7 @@ Parallelism options ------------------- **`-J`**, **`--build-jobs`** NUM -Number of jobs to run during build phase. Default: same as --jobs. +Number of jobs to run during build phase. Default: same as **`--jobs`**. Supported by: build|install|rebuild|traverse. **`-j`**, **`--jobs`** NUM @@ -653,8 +655,8 @@ Path to the TLS server certificate. Path to the TLS server key. **`--log-operations-threshold`** INT -Once the number of operations stored exceeds twice 2^n, where n is -given by the option `--log-operations-threshold`, at most 2^n operations +Once the number of operations stored exceeds twice 2^n, where n is given +by the option **`--log-operations-threshold`**, at most 2^n operations will be removed, in a FIFO scheme. If unset, defaults to 14. Must be in the range \[0,255\]. |