summaryrefslogtreecommitdiff
path: root/share
diff options
context:
space:
mode:
authorSascha Roloff <sascha.roloff@huawei.com>2023-06-23 18:32:07 +0200
committerSascha Roloff <sascha.roloff@huawei.com>2023-06-26 16:20:53 +0200
commitacb0203fef7e39a3817d9b2dc74f54bdf4ce00e4 (patch)
treedd81e8bd269738504e0121fb05e2544386359659 /share
parent903537d36fd3c5fa9a235eebf72e0e1d595bad00 (diff)
downloadjustbuild-acb0203fef7e39a3817d9b2dc74f54bdf4ce00e4.tar.gz
man pages: unify emphasis of just commands for man and markdown viewers
Diffstat (limited to 'share')
-rw-r--r--share/man/just-import-git.1.md6
-rw-r--r--share/man/just-mr-repository-config.5.md4
-rw-r--r--share/man/just-mr.1.md73
-rw-r--r--share/man/just-mrrc.5.md18
-rw-r--r--share/man/just-repository-config.5.md4
-rw-r--r--share/man/just.1.md140
6 files changed, 123 insertions, 122 deletions
diff --git a/share/man/just-import-git.1.md b/share/man/just-import-git.1.md
index f3d143be..6da015aa 100644
--- a/share/man/just-import-git.1.md
+++ b/share/man/just-import-git.1.md
@@ -9,7 +9,7 @@ configuration
SYNOPSIS
========
-just-import-deps \[*`OPTION`*\]... *`URL`* \[*`foreign repository name`*\]
+**`just-import-git`** \[*`OPTION`*\]... *`URL`* \[*`foreign repository name`*\]
DESCRIPTION
===========
@@ -54,7 +54,7 @@ recorded as the branch to follow. Defaults to *`"master"`*.
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`
+specified, for a config file is searched in the same way, as **`just-mr`**
does, when invoved with **`--norc`**.
**`-h`**, **`--help`**
@@ -70,7 +70,7 @@ compatible repository already exists in the configuration.
**`-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`
+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
diff --git a/share/man/just-mr-repository-config.5.md b/share/man/just-mr-repository-config.5.md
index 1720a19d..7b628593 100644
--- a/share/man/just-mr-repository-config.5.md
+++ b/share/man/just-mr-repository-config.5.md
@@ -132,7 +132,7 @@ The following fields are supported:
It defines as workspace root a directory with the distribution archives
of the specified repositories. Usually this root is realized as a Git
-tree in the Git repository in `just`'s local build root.
+tree in the Git repository in **`just`**'s local build root.
The following fields are supported:
@@ -156,7 +156,7 @@ supported. If its value is *`true`*, it indicates that the workspace
root should be returned as a Git tree. If the root directory is already
part of a Git repository, its Git tree identifier is used; otherwise,
the workspace root will be realized as a Git tree in the Git repository
-in `just`'s local build root.
+in **`just`**'s local build root.
Repository description
----------------------
diff --git a/share/man/just-mr.1.md b/share/man/just-mr.1.md
index 182397c0..6447d0b4 100644
--- a/share/man/just-mr.1.md
+++ b/share/man/just-mr.1.md
@@ -9,18 +9,19 @@ just-mr - multi-repository configuration tool and launcher for
SYNOPSIS
========
-just-mr \[*`OPTION`*\]... mrversion
-just-mr \[*`OPTION`*\]... {setup|setup-env} \[**`--all`**\] \[*`main-repo`*\]
-just-mr \[*`OPTION`*\]... fetch \[**`--all`**\] \[**`-o`** *`fetch-dir`*\] \[*`main-repo`*\]
-just-mr \[*`OPTION`*\]... update \[*`repo`*\]...
-just-mr \[*`OPTION`*\]... do \[*`JUST_ARG`*\]...
-just-mr \[*`OPTION`*\]... {version|analyse|build|install|install-cas|describe|rebuild} \[*`JUST_ARG`*\]...
+**`just-mr`** \[*`OPTION`*\]... **`mrversion`**
+**`just-mr`** \[*`OPTION`*\]... {**`setup`**|**`setup-env`**} \[**`--all`**\] \[*`main-repo`*\]
+**`just-mr`** \[*`OPTION`*\]... **`fetch`** \[**`--all`**\] \[**`-o`** *`fetch-dir`*\] \[*`main-repo`*\]
+**`just-mr`** \[*`OPTION`*\]... **`update`** \[*`repo`*\]...
+**`just-mr`** \[*`OPTION`*\]... **`do`** \[*`JUST_ARG`*\]...
+**`just-mr`** \[*`OPTION`*\]... {**`version`**|**`analyse`**|**`build`**|**`install`**|**`install-cas`**|**`describe`**|**`rebuild`**} \[*`JUST_ARG`*\]...
DESCRIPTION
===========
Just-MR is a configuration tool for the multi-repository Just build
-system. It can be used both standalone and as a launcher for `just`.
+system. It can be used both standalone and as a launcher for
+**`just`**(1).
The tool performs specific operations, based on the invoked subcommand,
on repositories described in a configuration file. All subcommands
@@ -40,11 +41,11 @@ Output a usage message and exit.
**`-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
+file is specified, **`just-mr`** will look for one in the following
order:
- - *`$WORKSPACE_ROOT/repos.json`* (workspace of the `just-mr` invocation)
- - *`$WORKSPACE_ROOT/etc/repos.json`* (workspace of the `just-mr`
+ - *`$WORKSPACE_ROOT/repos.json`* (workspace of the **`just-mr`** invocation)
+ - *`$WORKSPACE_ROOT/etc/repos.json`* (workspace of the **`just-mr`**
invocation)
- *`$HOME/.just-repos.json`*
- *`/etc/just-repos.json`*
@@ -94,7 +95,7 @@ Default: the single file path *`".distfiles"`* in user's home directory.
**`--main`** *`NAME`*
The repository to take the target from.
**`-f`**, **`--log-file`** *`PATH`*
-Path to local log file. `just-mr` will store the information printed on
+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.
@@ -135,19 +136,19 @@ Option to prevent reading any **just-mrrc(5)** file.
SUBCOMMANDS
===========
-mrversion
----------
+**`mrversion`**
+---------------
Print on stdout a JSON object providing version information for this
-tool itself; the `version` subcommand calls the `version` subcommand of
+tool itself; the **`version`** subcommand calls the **`version`** subcommand of
just. The version information for just-mr is in the same format that
-also `just` uses.
+also **`just`** uses.
-setup|setup-env
-----------------
+**`setup`**|**`setup-env`**
+---------------------------
These subcommands fetch all required repositories and generate an
-appropriate multi-repository `just` configuration file. The resulting
+appropriate multi-repository **`just`** configuration file. The resulting
file is stored in CAS and its path is printed to stdout. See
**just-repository-config(5)** for more details on the resulting
configuration file format.
@@ -160,11 +161,11 @@ the configuration is used. To perform the setup for all repositories
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
+main repository. In the case of **`setup-env`**, the workspace root of the
main repository is left out, such that it can be deduced from the
-working directory when `just` is invoked. In this way, working on a
+working directory when **`just`** is invoked. In this way, working on a
checkout of that repository is possible, while having all of its
-dependencies properly set up. In the case of `setup`, the workspace root
+dependencies properly set up. In the case of **`setup`**, the workspace root
of the main repository is taken as-is into the output configuration
file.
@@ -174,7 +175,7 @@ fetch
This subcommand prepares all archive-type workspace roots for an offline
build by fetching all their required source files from the specified
locations given in the input configuration file. Any subsequent
-`just-mr` or `just` invocations containing fetched archive workspace
+**`just-mr`** or **`just`** invocations containing fetched archive workspace
roots will thus need no further network connections.
If a main repository is provided in the input configuration or on
@@ -196,7 +197,7 @@ update
This subcommand updates the specified repositories (possibly none) and
prints the resulting updated configuration file to stdout.
-Currently, `just-mr` can only update Git repositories and it will fail
+Currently, **`just-mr`** can only update Git repositories and it will fail
if a different repository type is given. The tool also fails if any of
the given repository names are not found in the configuration file.
@@ -210,36 +211,36 @@ do
--
This subcommand is used as the canonical way of specifying just
-arguments and calling `just` via **execvp(2)**. Any subsequent argument
-is unconditionally forwarded to `just`. For *known* subcommands
-(version, describe, analyse, build, install, install-cas, rebuild), the
-`just-mr setup` step is performed first for those commands accepting a
+arguments and calling **`just`** via **execvp(2)**. Any subsequent argument
+is unconditionally forwarded to **`just`**. For *known* subcommands
+(**`version`**, **`describe`**, **`analyse`**, **`build`**, **`install`**, **`install-cas`**, **`rebuild`**), the
+**`just-mr setup`** step is performed first for those commands accepting a
configuration and the produced configuration is prefixed to the provided
-arguments. The main repository for the `setup` step can be provided in
+arguments. The main repository for the **`setup`** step can be provided in
the configuration or on the command line. If no main repository is
provided, the lexicographical first repository from the configuration is
used.
-All logging arguments given to `just-mr` are passed to `just` as early
+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.
-The **`--local-launcher`** argument is passed to `just` as early
+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
---------------------------------------------------------------------
+**`version`**|**`describe`**|**`analyse`**|**`build`**|**`install`**|**`install-cas`**|**`rebuild`**|**`gc`**
+-------------------------------------------------------------------------------------------------------------
This subcommand is the explicit way of specifying *known* just
-subcommands and calling `just` via **execvp(2)**. The same description
-as for the `do` subcommand applies.
+subcommands and calling **`just`** via **execvp(2)**. The same description
+as for the **`do`** subcommand applies.
EXIT STATUS
===========
-The exit status of `just-mr` is one of the following values:
+The exit status of **`just-mr`** is one of the following values:
- 0: the command completed successfully
- 64: setup succeeded, but exec failed
@@ -252,7 +253,7 @@ The exit status of `just-mr` is one of the following values:
- 71: error during setup
Any other exit code that does not have bit 64 set is a status value from
-`just`, if `just-mr` is used as a launcher. See **just(1)** for more
+**`just`**, if **`just-mr`** is used as a launcher. See **just(1)** for more
details.
See also
diff --git a/share/man/just-mrrc.5.md b/share/man/just-mrrc.5.md
index dc901d16..bce59b23 100644
--- a/share/man/just-mrrc.5.md
+++ b/share/man/just-mrrc.5.md
@@ -25,7 +25,7 @@ The value for key *`"root"`* is either *`"workspace"`*, *`"home"`*, or
- *`"workspace"`* refers to the root of the workspace in which the
`just-mr` invocation was issued (not the workspace of the requested
- main repository). This location root is ignored if `just-mr` was not
+ main repository). This location root is ignored if **`just-mr`** was not
invoked from inside a workspace.
- *`"home"`* refers to the user's home directory.
@@ -61,20 +61,20 @@ The just-mrrc is given by a JSON object.
- The value for the key *`"distdirs"`* is a JSON list of location
objects, specifying where to look for distribution files (usually
- collected via the subcommand `fetch`). The lookup is performed in
+ collected via the subcommand **`fetch`**). The lookup is performed in
the same order the location objects appear in the list. For more
details, see **just-mr(1)**.
- The value for the key *`"just"`* is a single location object,
- specifying the path to the `just` binary to use for execution, if
- `just-mr` is used as a launcher.
+ specifying the path to the **`just`** binary to use for execution, if
+ **`just-mr`** is used as a launcher.
- The value for the key *`"git"`* is a single location object,
specifying the path to the git binary to use in the instances when
- `just-mr` needs to shell out.
+ **`just-mr`** needs to shell out.
- The value for the key *`"local launcher"`*, if given, is list of
- strings setting the default for local launcher for `just-mr`;
+ strings setting the default for local launcher for **`just-mr`**;
command-line arguments take precedence over the value in the
configuration file. If the key *`"local launcher"`* is absent, the
default *`["env", "--"]`* is assumed.
@@ -88,9 +88,9 @@ The just-mrrc is given by a JSON object.
on the command line.
- The value for the key *`"just args"`* is a JSON object. Its keys are
- `just` subcommands and its value is a JSON list of strings. For the
- corresponding subcommand, these strings are prefixed to the `just`
- argument vector, if `just-mr` is used as a launcher.
+ **`just`** subcommands and its value is a JSON list of strings. For the
+ corresponding subcommand, these strings are prefixed to the **`just`**
+ argument vector, if **`just-mr`** is used as a launcher.
EXAMPLE
=======
diff --git a/share/man/just-repository-config.5.md b/share/man/just-repository-config.5.md
index ed7cbbdf..05e33c8b 100644
--- a/share/man/just-repository-config.5.md
+++ b/share/man/just-repository-config.5.md
@@ -9,7 +9,7 @@ just repository config -- The format of the repository config used by
DESCRIPTION
===========
-`just`'s repository configuration is read as JSON. Any other
+**`just`**'s repository configuration is read as JSON. Any other
serialization describing the same JSON object is equivalent. We assume,
that in JSON objects, each key occurs at most once; it is implementation
defined how repetitions of the same key are treated.
@@ -43,7 +43,7 @@ contains *`file roots`*, file names, and bindings to other repositories.
Specifically the following fields are supported:
- *`"workspace_root"`* contains the *`file root`* where source files
- are located. If this entry is missing for the main repository, `just`
+ are located. If this entry is missing for the main repository, **`just`**
will perform the normal workspace root resolution starting from the
current working directory.
diff --git a/share/man/just.1.md b/share/man/just.1.md
index 6d453cc2..13dfdedd 100644
--- a/share/man/just.1.md
+++ b/share/man/just.1.md
@@ -8,15 +8,15 @@ just - a generic build tool.
SYNOPSIS
========
-just version
-just {analyse|build} \[*`OPTION`*\]... \[\[*`module`*\] *`target`*\]
-just install \[*`OPTION`*\]... **`-o`** *`OUTPUT_DIR`* \[\[*`module`*\] *`target`*\]
-just install-cas \[*`OPTION`*\]... *`OBJECT_ID`*
-just describe \[*`OPTION`*\]... \[\[*`module`*\] *`target`*\]
-just rebuild \[*`OPTION`*\]... \[\[*`module`*\] *`target`*\]
-just traverse \[*`OPTION`*\]... **`-o`** *`OUTPUT_DIR`* **`-g`** *`GRAPH_FILE`*
-just gc \[*`OPTION`*\]...
-just execute \[*`OPTION`*\]...
+**`just`** **`version`**
+**`just`** {**`analyse`**|**`build`**} \[*`OPTION`*\]... \[\[*`module`*\] *`target`*\]
+**`just`** **`install`** \[*`OPTION`*\]... **`-o`** *`OUTPUT_DIR`* \[\[*`module`*\] *`target`*\]
+**`just`** **`install-cas`** \[*`OPTION`*\]... *`OBJECT_ID`*
+**`just`** **`describe`** \[*`OPTION`*\]... \[\[*`module`*\] *`target`*\]
+**`just`** **`rebuild`** \[*`OPTION`*\]... \[\[*`module`*\] *`target`*\]
+**`just`** **`traverse`** \[*`OPTION`*\]... **`-o`** *`OUTPUT_DIR`* **`-g`** *`GRAPH_FILE`*
+**`just`** **`gc`** \[*`OPTION`*\]...
+**`just`** **`execute`** \[*`OPTION`*\]...
DESCRIPTION
===========
@@ -37,7 +37,7 @@ the empty string. Specifying the correct repository, target root,
module, and target name allows to process that target independently of
the current working directory.
-If the module is not specified on the command line, `just` sets the
+If the module is not specified on the command line, **`just`** sets the
module corresponding to the current working directory.
If a target is not specified, the lexicographically-first target,
@@ -45,7 +45,7 @@ according to native byte order, is used. So, a target named with an
empty string will always be the default target for that module.
If a target depends on other targets defined in other modules or
-repositories, `just` will recursively visit all and only the required
+repositories, **`just`** will recursively visit all and only the required
modules.
The main repository is the repository containing the target specified on
@@ -61,8 +61,8 @@ 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
+**`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
@@ -71,7 +71,7 @@ the parent directories until it finds one. The supported markers are
- *`.git`* (can be either a file - empty or not, content is ignored -
or the famous directory)
-If it fails, `just` errors out.
+If it fails, **`just`** errors out.
For non-main repositories, the *`workspace_root`* entry must be declared
in the multi-repository configuration file.
@@ -84,7 +84,7 @@ file. If it is not specified there, the default value is used. The
default value of *`target_root`* is *`workspace_root`*, of *`rule_root`*
is *`target_root`*, and of *`expression_root`* is *`rule_root`*.
-Finally, the file names where `targets`, `rules`, and `expressions` are
+Finally, the file names where *targets*, *rules*, and *expressions* are
defined for the main repository. If the corresponding key is present in
the multi-repository configuration file, it is set accordingly. If the
user gives the corresponding command-line option, it overwrites what is
@@ -102,8 +102,8 @@ the multi-repository configuration file.
SUBCOMMANDS
===========
-version
--------
+**`version`**
+-------------
Print on stdout a JSON object providing version information about the
version of the tool used. This JSON object will contain at least the
@@ -120,52 +120,52 @@ following keys.
commit that went into this binary. It is *`null`* if that time is not
known (e.g., in development builds).
-analyse|build|install
------------------------
+**`analyse`**|**`build`**|**`install`**
+---------------------------------------
-The subcommands `analyse`, `build`, and `install` are strictly related.
-In fact, from left to right, one is a subset of the other. `build`
-performs work on top of `analyse`, and `install` on top of `build`. When
-a user issues `build`, the `analyse` is called underneath. In
-particular, there is no need to run these three subcommands
-sequentially.
+The subcommands **`analyse`**, **`build`**, and **`install`** are
+strictly related. In fact, from left to right, one is a subset of the
+other. **`build`** performs work on top of **`analyse`**, and
+**`install`** on top of **`build`**. When a user issues **`build`**, the
+**`analyse`** is called underneath. In particular, there is no need to
+run these three subcommands sequentially.
-### analyse
+### **`analyse`**
analyse reads the target graph from *`TARGETS`* files for the given
-target, computes the action graph (required by e.g., build, install,
-traverse), and reports the artifacts, provides, and runfiles of the
+target, computes the action graph (required by e.g., **`build`**, **`install`**,
+**`traverse`**), and reports the artifacts, provides, and runfiles of the
analysed target.
-In short, the `analyse` subcommand identifies all the steps required to
-build a given target without actually performing those steps.
+In short, the **`analyse`** subcommand identifies all the steps required
+to **`build`** a given target without actually performing those steps.
This subcommand, issued with proper flags, can dump in JSON format
artifacts, action graph, nodes, actions, (transitive) targets (both
named and anonymous), and trees.
-### build
+### **`build`**
This subcommand performs the actions contained in the action graph
-computed through the `analyse` phase.
+computed through the **`analyse`** phase.
If building locally, the building process is performed in temporary
separate directories to allow for staging according to the logical path
described in the *`TARGETS`* file. Since artifacts are only stored in
-the CAS, the user has to use either the install or install-cas
+the CAS, the user has to use either the **`install`** or **`install-cas`**
subcommand to get them.
-`just` allows for both local (i.e., on the same machine where `just` is
+**`just`** allows for both local (i.e., on the same machine where **`just`** is
used) and remote compilation (i.e., by sending requests over a TCP
connection, e.g., to a different machine, cluster or cloud
infrastructure). In case of a remote compilation, artifacts are compiled
-remotely and stored in the remote CAS. `install` and `install-cas`
+remotely and stored in the remote CAS. **`install`** and **`install-cas`**
subcommands can be used to locally fetch and stage the desired
artifacts.
-### install
+### **`install`**
-The `install` subcommand determines which (if any) actions need to be
+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
@@ -173,8 +173,8 @@ 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.
-rebuild
--------
+**`rebuild`**
+-------------
This subcommand inspects if builds are fully reproducible or not (e.g.,
time stamps are used). It simply rebuilds and compares artifacts to the
@@ -182,24 +182,24 @@ cached build reporting actions with different output. To do so in a
meaningful way, it requires that previous build is already in the cache
(local or remote).
-describe
---------
+**`describe`**
+--------------
-The `describe` subcommand allows for describing the rule generating a
+The **`describe`** subcommand allows for describing the rule generating a
target. The rule is resolved in precisely the same way as during the
analysis. The doc-strings (if any) from the rule definition (if
user-defined) are reported, together with a summary of the declared
fields and their types. The multi-repository configuration is honored in
-the same way as during `analyse` and `build`; in particular, the rule
+the same way as during **`analyse`** and **`build`**; in particular, the rule
definition can also reside in a git-tree root.
-install-cas
------------
+**`install-cas`**
+-----------------
-install-cas fetches artifacts from CAS (Content Addressable Storage) by
+**`install-cas`** fetches artifacts from CAS (Content Addressable Storage) by
means of their *`OBJECT_ID`* (object identifier). The canonical format
of an object identifier is *`[<hash>:<size>:<type>]`*; however, when
-parsing an object identifier, install-cas uses the following default
+parsing an object identifier, **`install-cas`** uses the following default
rules, to make usage simpler.
- The square brackets are optional.
@@ -247,25 +247,25 @@ description.
If the artifact is a file, it will replace the existing file. If the
artifact is a tree, it will cause an error.
-traverse
---------
+**`traverse`**
+--------------
It allows for the building and staging of requested artifacts from a
well-defined *`GRAPH_FILE`*. See **just-graph-file(5)** for more
details.
-gc
---
+**`gc`**
+--------
-The **gc** subcommand triggers garbage collection of the local cache.
+The **`gc`** subcommand triggers garbage collection of the local cache.
More precisely, it rotates the cache and CAS generations. During a
build, upon cache hit, everything related to that cache hit is uplinked
-to the youngest generation; therefore, upon a call to `gc` everything
-not referenced since the last call to `gc` is purged and the
+to the youngest generation; therefore, upon a call to **`gc`** everything
+not referenced since the last call to **`gc`** is purged and the
corresponding disk space reclaimed.
-execute
--------
+**`execute`**
+-------------
This subcommand starts a single node remote execution service, honoring
the just native remote protocol.
@@ -400,7 +400,7 @@ interpreted as stdout. Note that, passing *`.`*/*`-`* will instead
create a file named *`-`* in the current directory. Output format is
JSON map with staging path as key, and object id description (hash,
type, size) as value. Each artifact is guaranteed to be *`KNOWN`* in
-CAS. Therefore, this option cannot be used with analyse.
+CAS. Therefore, this option cannot be used with **`analyse`**.
Supported by: build|install|rebuild|traverse.
**`--dump-graph`** *`PATH`*
@@ -409,7 +409,7 @@ File path for writing the action graph description to. See
Supported by: analyse|build|install|rebuild.
**`-f`**, **`--log-file`** *`PATH`*
-Path to local log file. `just` will store the information printed on
+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:
@@ -453,7 +453,7 @@ If the artifacts have been already staged, they will be overwritten.
Required by: install|traverse.
**`-o`**, **`--output-path`** *`PATH`*
-Install path for the artifact. Refer to **install-cas** section for more
+Install path for the artifact. Refer to **`install-cas`** section for more
details.
Supported by: install-cas
@@ -516,8 +516,8 @@ Path to a TLS client key to enable mTLS. It must be passed in
conjunction with **`--tls-client-cert`** and **`--tls-ca-cert`**. Supported
by: build|install-cas|install|rebuild|traverse.
-**analyse** specific options
-----------------------------
+**`analyse`** specific options
+------------------------------
**`--dump-actions`** *`PATH`*
Dump actions to file. *`-`* is treated as stdout. Output is a list of
@@ -598,8 +598,8 @@ treated as stdout. Output is a JSON map between tree ids and the
corresponding artifact map, which maps the path to the artifact
description.
-**rebuild** specific options
-----------------------------
+**`rebuild`** specific options
+------------------------------
**`--vs`** *`NAME`*:*`PORT`*|*`"local"`*
Cache endpoint to compare against (use *`"local"`* for local cache).
@@ -607,8 +607,8 @@ Cache endpoint to compare against (use *`"local"`* for local cache).
**`--dump-flaky`** *`PATH`*
Dump flaky actions to file.
-**traverse** specific options
------------------------------
+**`traverse`** specific options
+-------------------------------
**`-a`**, **`--artifacts`** *`TEXT`*
JSON maps between relative path where to copy the artifact and its
@@ -622,8 +622,8 @@ Path of the file containing the description of the actions. See
Path to a git repository, containing blobs of potentially missing
*`KNOWN`* artifacts.
-**describe** specific options
------------------------------
+**`describe`** specific options
+-------------------------------
**`--json`**
Omit pretty-printing and describe rule in JSON format.
@@ -631,8 +631,8 @@ Omit pretty-printing and describe rule in JSON format.
**`--rule`**
Module and target arguments refer to a rule instead of a target.
-**execute** specific options
-----------------------------
+**`execute`** specific options
+------------------------------
**`-p`**, **`--port`** *`INT`*
Execution service will listen to this port. If unset, the service will
@@ -664,7 +664,7 @@ operations will be removed, in a FIFO scheme. If unset, defaults to
EXIT STATUS
===========
-The exit status of `just` is one of the following values:
+The exit status of **`just`** is one of the following values:
- 0: the command completed successfully
- 1: the command could not complete due to some errors (e.g.,