diff options
author | Klaus Aehlig <klaus.aehlig@huawei.com> | 2023-06-19 14:28:53 +0200 |
---|---|---|
committer | Klaus Aehlig <klaus.aehlig@huawei.com> | 2023-06-20 10:29:29 +0200 |
commit | ffef561209455438b1d8a398197dace9951e099f (patch) | |
tree | 72262b0facc908eabdbc16c18ebd9aed04295f57 /share | |
parent | 367805d04c905f19a9dc4156091a7bfb7a518387 (diff) | |
download | justbuild-ffef561209455438b1d8a398197dace9951e099f.tar.gz |
man pages: properly quote options
... in order to preserve the minus signs.
Diffstat (limited to 'share')
-rw-r--r-- | share/man/just-import-git.1.md | 14 | ||||
-rw-r--r-- | share/man/just-mr.1.md | 40 | ||||
-rw-r--r-- | share/man/just.1.md | 138 |
3 files changed, 96 insertions, 96 deletions
diff --git a/share/man/just-import-git.1.md b/share/man/just-import-git.1.md index adbb8a6b..be746655 100644 --- a/share/man/just-import-git.1.md +++ b/share/man/just-import-git.1.md @@ -39,34 +39,34 @@ The resulting configuration is printed on standard output. OPTIONS ======= -**--as** NAME +**`--as`** NAME Specify the name the imported repository should have in the final configuration. If not specified, default to the name the repository has in the configuration file of the repository imported. In any case, the name is amended if it conflicts with an already existing name. -**-b** BRANCH +**`-b`** BRANCH The branch in the imported repository to use; this branch is also recorded as the branch to follow. Defaults to `"master"`. -**-C** CONFIGFILE +**`-C`** CONFIGFILE 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`. -**-h**, **--help** +**`-h`**, **`--help`** Output a usage message and exit. -**--map** THEIRS OURS +**`--map`** THEIRS OURS Map repositories from the imported configuration to already existing ones. Those repositories are not imported (and the search for their transitive dependency is omitted) and instead the specified already existing repository is used. This is useful, if a sufficiently compatible repository already exists in the configuration. -**-R** RELPATH +**`-R`** RELPATH 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` @@ -74,7 +74,7 @@ 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** +**`--plain`** Pretend the foreign multi-repository specification is the canonical one for a single repository. Useful, if the repository to be imported does not have a repository configuration or should be imported without diff --git a/share/man/just-mr.1.md b/share/man/just-mr.1.md index b64c2d6f..c603d774 100644 --- a/share/man/just-mr.1.md +++ b/share/man/just-mr.1.md @@ -36,10 +36,10 @@ OPTIONS General options --------------- -**-h**, **--help** +**`-h`**, **`--help`** Output a usage message and exit. -**-C**, **--repository-config** PATH +**`-C`**, **`--repository-config`** PATH Path to the multi-repository configuration file. See **just-mr-repository-config(5)** for more details. If no configuration file is specified, `just-mr` will look for one in the following @@ -54,20 +54,20 @@ order: The default configuration lookup order can be adjusted in the just-mrrc file. See **just-mrrc(5)** for more details. -**-D**, **--defines** JSON +**`-D`**, **`--defines`** JSON Defines, via an in-line JSON object, an overlay configuration for **just(1)**; if used as a launcher for a subcommand known to support -**--defines**, this defines value is forwarded, otherwise it is ignored. -If **-D** is given several times, the **-D** options overlay (in the +**`--defines`**, this defines value is forwarded, otherwise it is ignored. +If **`-D`** is given several times, the **`-D`** options overlay (in the sense of `map_union`) in the order they are given on the command line. -**--local-build-root** PATH +**`--local-build-root`** PATH Root for local CAS, cache, and build directories. The path will be created if it does not exist already. This option overwrites any values set in the **just-mrrc(5)** file. Default: path `".cache/just"` in user's home directory. -**--checkout-locations** PATH +**`--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 @@ -78,12 +78,12 @@ the respective repository. 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 +**`-L`**, **`--local-launcher`** JSON_ARRAY JSON array with the list of strings representing the launcher to prepend actions' commands before being executed locally. Default: `["env", "--"]`. -**--distdir** PATH +**`--distdir`** PATH Directory to look for distfiles before fetching. If given, this will be the first place distfiles are looked for. This option can be given multiple times to specify a list of distribution directories that are @@ -92,45 +92,45 @@ Directories specified via this option will be appended to the ones set in the **just-mrrc(5)** file. Default: the single file path `".distfiles"` in user's home directory. -**--main** NAME +**`--main`** NAME The repository to take the target from. -**-f,--log-file** PATH +**`-f`**, **`--log-file`** PATH Path to local log file. `just-mr` will store the information printed on stderr in the log file along with the thread id and timestamp when the output has been generated. -**--log-limit** NUM +**`--log-limit`** NUM Log limit (higher is more verbose) in interval \[0,6\] (Default: 3). -**--plain-log** +**`--plain-log`** Do not use ANSI escape sequences to highlight messages. -**--log-append** +**`--log-append`** Append messages to log file instead of overwriting existing. -**--no-fetch-ssl-verify** +**`--no-fetch-ssl-verify`** Disable the default peer SSL certificate verification step when fetching archives (for which we verify the hash anyway) from remote. -**--fetch-cacert** PATH +**`--fetch-cacert`** PATH Path to the CA certificate bundle containing one or more certificates to be used to peer verify archive fetches from remote. -**--just** PATH +**`--just`** PATH Name of the just binary in `PATH` or path to the just binary. Default: `"just"`. -**--rc** PATH +**`--rc`** PATH Path to the just-mrrc file to use. See **just-mrrc(5)** for more details. Default: file path `".just-mrrc"` in the user's home directory. -**--git** PATH +**`--git`** PATH Path to the git binary in `PATH` or path to the git binary. Used in the rare instances when shelling out to git is needed. Default: `"git"`. -**--norc** +**`--norc`** Option to prevent reading any **just-mrrc(5)** file. SUBCOMMANDS diff --git a/share/man/just.1.md b/share/man/just.1.md index 9ea60d01..ba93b53f 100644 --- a/share/man/just.1.md +++ b/share/man/just.1.md @@ -277,14 +277,14 @@ OPTIONS Generic program information --------------------------- -**-h**, **--help** +**`-h`**, **`--help`** Output a usage message and exit. Supported by: all subcommands. Compatibility options --------------------- -**--compatible** +**`--compatible`** At increased computational effort, be compatible with the original remote build execution protocol. As the change affects identifiers, the flag must be used consistently for all related invocations. @@ -294,28 +294,28 @@ analyse|build|install-cas|install|rebuild|traverse|execute. Build configuration options --------------------------- -**--action-timeout** NUM +**`--action-timeout`** NUM Action timeout in seconds. (Default: 300). The timeout is honored only for the remote build. Supported by: build|install|rebuild|traverse. -**-c**, **--config** PATH +**`-c`**, **`--config`** PATH Path to configuration file. Supported by: analyse|build|describe|install|rebuild. -**-C**, **--repository-config** PATH +**`-C`**, **`--repository-config`** PATH Path to configuration file for multi-repository builds. See **just-repository-config(5)** for more details. Supported by: analyse|build|describe|install|rebuild|traverse. -**-D**, **--defines** JSON +**`-D`**, **`--defines`** JSON Defines, via an in-line JSON object a configuration to overlay (in the -sense of `map_union`) to the configuration obtained by the **--config** -option. If **-D** is given several times, the **-D** options overlay in +sense of `map_union`) to the configuration obtained by the **`--config`** +option. If **`-D`** is given several times, the **`-D`** options overlay in the order they are given on the command line. Supported by: analyse|build|describe|install|rebuild. -**--request-action-input** ACTION +**`--request-action-input`** ACTION Modify the request to be, instead of the analysis result of the requested target, the input stage of the specified action as artifacts, with empty runfiles and a provides map providing the remaining @@ -336,62 +336,62 @@ An action can be specified in the following ways Supported by: analyse|build|describe|install|rebuild. -**--expression-file-name** TEXT +**`--expression-file-name`** TEXT Name of the expressions file. Supported by: analyse|build|describe|install|rebuild. -**--expression-root** PATH +**`--expression-root`** PATH Path of the expression files' root directory. Default: Same as --rule-root. Supported by: analyse|build|describe|install|rebuild. -**-L**, **--local-launcher** JSON_ARRAY +**`-L`**, **`--local-launcher`** JSON_ARRAY JSON array with the list of strings representing the launcher to prepend actions' commands before being executed locally. Default value: `["env", "--"]` Supported by: build|install|rebuild|traverse|execute. -**--local-build-root** PATH +**`--local-build-root`** PATH Root for local CAS, cache, and build directories. The path will be created if it does not exist already. Supported by: build|install-cas|install|rebuild|traverse|gc|execute. -**--main** NAME +**`--main`** NAME The repository to take the target from. Supported by: analyse|build|describe|install|rebuild|traverse. -**--rule-file-name** TEXT +**`--rule-file-name`** TEXT Name of the rules file. Supported by: analyse|build|describe|install|rebuild. -**--rule-root** PATH +**`--rule-root`** PATH Path of the rule files' root directory. Default: Same as --target-root Supported by: analyse|build|describe|install|rebuild. -**--target-file-name** TEXT +**`--target-file-name`** TEXT Name of the targets file. Supported by: analyse|build|describe|install|rebuild. -**--target-root** PATH +**`--target-root`** PATH Path of the target files' root directory. Default: Same as --workspace-root Supported by: analyse|build|describe|install|rebuild. -**-w**, **--workspace-root** PATH +**`-w`**, **`--workspace-root`** PATH Path of the workspace's root directory. Supported by: analyse|build|describe|install|rebuild|traverse. General output options ---------------------- -**--dump-artifacts-to-build** PATH +**`--dump-artifacts-to-build`** PATH File path for writing the artifacts to build to. Output format is JSON map with staging path as key, and intentional artifact description as value. Supported by: analyse|build|install|rebuild. -**--dump-artifacts** PATH +**`--dump-artifacts`** PATH Dump artifacts generated by the given target. Using `-` as PATH, it is interpreted as stdout. Note that, passing `./-` will instead create a file named `-` in the current directory. Output format is JSON map with @@ -400,66 +400,66 @@ value. Each artifact is guaranteed to be KNOWN in CAS. Therefore, this option cannot be used with `analyse`. Supported by: build|install|rebuild|traverse. -**--dump-graph** PATH +**`--dump-graph`** PATH File path for writing the action graph description to. See **just-graph-file(5)** for more details. Supported by: analyse|build|install|rebuild. -**-f,--log-file** PATH +**`-f`**, **`--log-file`** PATH Path to local log file. `just` will store the information printed on stderr in the log file along with the thread id and timestamp when the output has been generated. Supported by: analyse|build|describe|install|install-cas|rebuild|traverse|gc|execute. -**--log-limit** NUM +**`--log-limit`** NUM Log limit (higher is more verbose) in interval \[0,6\] (Default: 3). Supported by: analyse|build|describe|install|install-cas|rebuild|traverse|gc|execute. -**--plain-log** +**`--plain-log`** Do not use ANSI escape sequences to highlight messages. Supported by: analyse|build|describe|install|install-cas|rebuild|traverse|gc|execute. -**--log-append** +**`--log-append`** Append messages to log file instead of overwriting existing. Supported by: analyse|build|describe|install|install-cas|rebuild|traverse|gc|execute. -**--expression-log-limit** NUM +**`--expression-log-limit`** NUM In error messages, truncate the entries in the enumeration of the active environment, as well as the expression to be evaluated, to the specified number of characters (default: 320). Supported by: analyse|build|install -**-P**, **--print-to-stdout** LOGICAL_PATH +**`-P`**, **`--print-to-stdout`** LOGICAL_PATH After building, print the specified artifact to stdout. -**-s**, **--show-runfiles** +**`-s`**, **`--show-runfiles`** Do not omit runfiles in build report. Supported by: build|install|rebuild|traverse. Output dir and path ------------------- -**-o**, **--output-dir** PATH +**`-o`**, **`--output-dir`** PATH Path of the directory where outputs will be copied. If the output path does not exist, it will create all the necessary folders and subfolders. If the artifacts have been already staged, they will be overwritten. Required by: install|traverse. -**-o**, **--output-path** PATH +**`-o`**, **`--output-path`** PATH Install path for the artifact. Refer to **install-cas** section for more details. Supported by: install-cas -**--raw-tree** -When installing a tree to stdout, i.e., when no option **-o** is given, +**`--raw-tree`** +When installing a tree to stdout, i.e., when no option **`-o`** is given, dump the raw tree rather than a pretty-printed version. Supported by: install-cas -**--remember** +**`--remember`** Ensure that all installed artifacts are available in local CAS as well, even when using remote execution. Supported by: install|traverse|install-cas @@ -467,11 +467,11 @@ install|traverse|install-cas Parallelism options ------------------- -**-J**, **--build-jobs** NUM +**`-J`**, **`--build-jobs`** NUM Number of jobs to run during build phase. Default: same as --jobs. Supported by: build|install|rebuild|traverse. -**-j**, **--jobs** NUM +**`-j`**, **`--jobs`** NUM Number of jobs to run. Default: Number of cores. Supported by: analyse|build|describe|install|rebuild|traverse. @@ -481,15 +481,15 @@ Remote execution options As remote execution properties shard the target-level cache, they are also available for analysis. In this way, the same action identifiers can be achieved despite the extensional projection inherent to target -level caching, e.g., in conjunction with **--request-action-input**. +level caching, e.g., in conjunction with **`--request-action-input`**. -**--remote-execution-property** KEY:VAL +**`--remote-execution-property`** KEY:VAL Property for remote execution as key-value pair. Specifying this option multiple times will accumulate pairs. If multiple pairs with the same key are given, the latest wins. Supported by: analyse|build|install|rebuild|traverse. -**-r**, **--remote-execution-address** NAME:PORT +**`-r`**, **`--remote-execution-address`** NAME:PORT Address of the remote execution service. Supported by: analyse|build|install-cas|install|rebuild|traverse. @@ -498,46 +498,46 @@ Authentication options Only TLS and mutual TLS (mTLS) are supported. -**--tls-ca-cert** PATH +**`--tls-ca-cert`** PATH Path to a TLS CA certificate that is trusted to sign the server certificate. Supported by: build|install-cas|install|rebuild|traverse|execute. -**--tls-client-cert** PATH +**`--tls-client-cert`** PATH Path to a TLS client certificate to enable mTLS. It must be passed in -conjunction with **--tls-client-key** and **--tls-ca-cert**. Supported +conjunction with **`--tls-client-key`** and **`--tls-ca-cert`**. Supported by: build|install-cas|install|rebuild|traverse. -**--tls-client-key** PATH +**`--tls-client-key`** PATH Path to a TLS client key to enable mTLS. It must be passed in -conjunction with **--tls-client-cert** and **--tls-ca-cert**. Supported +conjunction with **`--tls-client-cert`** and **`--tls-ca-cert`**. Supported by: build|install-cas|install|rebuild|traverse. **analyse** specific options ---------------------------- -**--dump-actions** PATH +**`--dump-actions`** PATH Dump actions to file. `-` is treated as stdout. Output is a list of action descriptions, in JSON format, for the given target. -**--dump-anonymous** PATH +**`--dump-anonymous`** PATH Dump anonymous targets to file. `-` is treated as stdout. Output is a JSON map, for all transitive targets, with two entries: `nodes` and `rule_maps`. The former contains maps between node id and the node description. `rule_maps` states the maps between the `mode_type` and the rule to use in order to make a target out of the node. -**--dump-blobs** PATH +**`--dump-blobs`** PATH Dump blobs to file. `-` is treated as stdout. The term `blob` identifies a collection of strings that the execution back end should be aware of before traversing the action graph. A blob, will be referred to as a KNOWN artifact in the action graph. -**--dump-nodes** PATH +**`--dump-nodes`** PATH Dump nodes of only the given target to file. `-` is treated as stdout. Output is a JSON map between node id and its description. -**--dump-vars** PATH +**`--dump-vars`** PATH Dump configuration variables to file. `-` is treated as stdout. The output is a JSON list of those variable names (in lexicographic order) at which the configuration influenced the analysis of this target. This @@ -545,7 +545,7 @@ might contain variables unset in the configuration if the fact that they were unset (and hence treated as the default `null`) was relevant for the analysis of that target. -**--dump-targets** PATH +**`--dump-targets`** PATH Dump all transitive targets to file for the given target. `-` is treated as stdout. Output is a JSON map of all targets encoded as tree by their entity name: @@ -564,12 +564,12 @@ entity name: } ``` -**--dump-export-targets** PATH +**`--dump-export-targets`** PATH Dump all transitive targets to file for the given target that are export targets. `-` is treated as stdout. The output format is the same as for -**--dump-targets**. +**`--dump-targets`**. -**--dump-targets-graph** PATH +**`--dump-targets-graph`** PATH Dump the graph of configured targets to a file (even if it is called `-`). In this graph, only non-source targets are reported. The graph is represented as a JSON object. The keys are the nodes of the graph, and @@ -590,7 +590,7 @@ target name (as `["@", repo, module, target]` or `["#", rule_map_id, node_id]`) and the second entry the effective configuration. -**--dump-trees** PATH +**`--dump-trees`** PATH Dump trees and all subtrees of the given target to file. `-` is treated as stdout. Output is a JSON map between tree ids and the corresponding artifact map, which maps the path to the artifact description. @@ -598,63 +598,63 @@ artifact map, which maps the path to the artifact description. **rebuild** specific options ---------------------------- -**--vs** NAME:PORT|"local" +**`--vs`** NAME:PORT|"local" Cache endpoint to compare against (use "local" for local cache). -**--dump-flaky** PATH +**`--dump-flaky`** PATH Dump flaky actions to file. **traverse** specific options ----------------------------- -**-a**, **--artifacts** TEXT +**`-a`**, **`--artifacts`** TEXT JSON maps between relative path where to copy the artifact and its description (as JSON object as well). -**-g**, **--graph-file** TEXT `[[REQUIRED]]` +**`-g`**, **`--graph-file`** TEXT `[[REQUIRED]]` Path of the file containing the description of the actions. See **just-graph-file(5)** for more details. -**--git-cas** TEXT +**`--git-cas`** TEXT Path to a Git repository, containing blobs of potentially missing KNOWN artifacts. **describe** specific options ----------------------------- -**--json** +**`--json`** Omit pretty-printing and describe rule in JSON format. -**--rule** +**`--rule`** Module and target arguments refer to a rule instead of a target. **execute** specific options ---------------------------- -**-p,--port** INT +**`-p`**, **`--port`** INT Execution service will listen to this port. If unset, the service will listen to the first available one. -**--info-file** TEXT +**`--info-file`** TEXT Write the used port, interface, and pid to this file in JSON format. If the file exists, it will be overwritten. -**-i,--interface** TEXT +**`-i`**, **`--interface`** TEXT Interface to use. If unset, the loopback device is used. -**--pid-file** TEXT +**`--pid-file`** TEXT Write pid to this file in plain txt. If the file exists, it will be overwritten. -**--tls-server-cert** TEXT +**`--tls-server-cert`** TEXT Path to the TLS server certificate. -**--tls-server-key** TEXT +**`--tls-server-key`** TEXT Path to the TLS server key. -**----log-operations-threshold** INT +**`--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 +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\]. |