diff options
-rw-r--r-- | share/man/just-graph-file.5.md | 6 | ||||
-rw-r--r-- | share/man/just-import-git.1.md | 5 | ||||
-rw-r--r-- | share/man/just-mr-repository-config.5.md | 14 | ||||
-rw-r--r-- | share/man/just-mr.1.md | 34 | ||||
-rw-r--r-- | share/man/just-mrrc.5.md | 13 | ||||
-rw-r--r-- | share/man/just-repository-config.5.md | 10 | ||||
-rw-r--r-- | share/man/just.1.md | 15 |
7 files changed, 51 insertions, 46 deletions
diff --git a/share/man/just-graph-file.5.md b/share/man/just-graph-file.5.md index 640283a2..298d0b54 100644 --- a/share/man/just-graph-file.5.md +++ b/share/man/just-graph-file.5.md @@ -3,7 +3,7 @@ NAME ==== -just graph file -- The format of the action graph used by **just(1)** +just graph file -- The format of the action graph used by **`just`**(1) DESCRIPTION =========== @@ -124,7 +124,7 @@ ignore those. Implementations writing action-graph files should be aware that a future version of this file format might give a specific meaning to those extra keys. -Graphs written by **just(1)** have the additional key *`"origins"`* in +Graphs written by **`just`**(1) have the additional key *`"origins"`* in each action. The value is a list of all places where this action was requested (so often, but not always, the list has length 1). Each such place is described by a JSON object with the following keys. @@ -143,4 +143,4 @@ place is described by a JSON object with the following keys. See also ======== -**just(1)** +**`just`**(1) diff --git a/share/man/just-import-git.1.md b/share/man/just-import-git.1.md index 6da015aa..3358f53e 100644 --- a/share/man/just-import-git.1.md +++ b/share/man/just-import-git.1.md @@ -14,7 +14,7 @@ SYNOPSIS DESCRIPTION =========== -Extend an existing **just-mr-repository-config(5)** by adding one git +Extend an existing **`just-mr-repository-config`**(5) by adding one git repository. In doing so, the dependencies declared in the imported repository are added as well and *`"file"`* repositories are transformed to *`"subdir"`* parts of the imported repository. This solves the @@ -85,4 +85,5 @@ dependencies. See also ======== -**just-mr-repository-config(5)**, **just-mr(1)** +**`just-mr-repository-config`**(5), +**`just-mr`**(1) diff --git a/share/man/just-mr-repository-config.5.md b/share/man/just-mr-repository-config.5.md index 7b628593..f0035e56 100644 --- a/share/man/just-mr-repository-config.5.md +++ b/share/man/just-mr-repository-config.5.md @@ -4,13 +4,13 @@ NAME ==== just-mr repository config -- The format of the repository config used by -**just-mr(1)** +**`just-mr`**(1) DESCRIPTION =========== -In order for the **just-mr(1)** tool to generate a repository -configuration file usable by the **just(1)** multi-repository build +In order for the **`just-mr`**(1) tool to generate a repository +configuration file usable by the **`just`**(1) multi-repository build system, it requires a configuration file describing repositories and their dependencies. @@ -210,11 +210,13 @@ Additional keys --------------- Any JSON object described in this format might have additional keys -besides the ones mentioned. The current strategy of **just-mr(1)** is to -accept and ignore them. Users should be aware that future versions of +besides the ones mentioned. The current strategy of **`just-mr`**(1) is +to accept and ignore them. Users should be aware that future versions of this format might give specific meanings to these extra keys. See also ======== -**just(1)**, **just-mr(1)**, **just-repository-config(5)** +**`just`**(1), +**`just-mr`**(1), +**`just-repository-config`**(5) diff --git a/share/man/just-mr.1.md b/share/man/just-mr.1.md index 6447d0b4..864e8480 100644 --- a/share/man/just-mr.1.md +++ b/share/man/just-mr.1.md @@ -4,7 +4,7 @@ NAME ==== just-mr - multi-repository configuration tool and launcher for -**just(1)**. +**`just`**(1) SYNOPSIS ======== @@ -26,7 +26,7 @@ system. It can be used both standalone and as a launcher for The tool performs specific operations, based on the invoked subcommand, on repositories described in a configuration file. All subcommands operate at the level of *workspace roots* deduced from the given -repository descriptions. See **just-mr-repository-config(5)** for more +repository descriptions. See **`just-mr-repository-config`**(5) for more details on the input format. OPTIONS @@ -40,7 +40,7 @@ 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 +**`just-mr-repository-config`**(5) for more details. If no configuration file is specified, **`just-mr`** will look for one in the following order: @@ -51,11 +51,11 @@ order: - *`/etc/just-repos.json`* The default configuration lookup order can be adjusted in the just-mrrc -file. See **just-mrrc(5)** for more details. +file. See **`just-mrrc`**(5) for more details. **`-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 +**`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 sense of *`map_union`*) in the order they are given on @@ -64,7 +64,7 @@ the command line. **`--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. +set in the **`just-mrrc`**(5) file. Default: path *`".cache/just"`* in user's home directory. **`--checkout-locations`** *`PATH`* @@ -75,7 +75,7 @@ paths as values. Currently supported version control is Git, therefore the respective key is *`"git"`*. The paths contained for each repository URL point to existing locations on the filesystem containing the checkout of the respective repository. This options overwrites any -values set in the **just-mrrc(5)** file. +values set in the **`just-mrrc`**(5) file. Default: file path *`".just-local.json"`* in user's home directory. **`-L`**, **`--local-launcher`** *`JSON_ARRAY`* @@ -89,7 +89,7 @@ the first place distfiles are looked for. This option can be given multiple times to specify a list of distribution directories that are used for lookup in the order they appear on the command line. Directories specified via this option will be appended to the ones set -in the **just-mrrc(5)** file. +in the **`just-mrrc`**(5) file. Default: the single file path *`".distfiles"`* in user's home directory. **`--main`** *`NAME`* @@ -121,7 +121,7 @@ Name of the just binary in *`PATH`* or path to the just binary. Default: *`"just"`*. **`--rc`** *`PATH`* -Path to the just-mrrc file to use. See **just-mrrc(5)** for more +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. @@ -131,7 +131,7 @@ the rare instances when shelling out to git is needed. Default: *`"git"`*. **`--norc`** -Option to prevent reading any **just-mrrc(5)** file. +Option to prevent reading any **`just-mrrc`**(5) file. SUBCOMMANDS =========== @@ -150,7 +150,7 @@ also **`just`** uses. These subcommands fetch all required repositories and generate an 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 +**`just-repository-config`**(5) for more details on the resulting configuration file format. If a main repository is provided in the input configuration or on @@ -211,7 +211,7 @@ do -- This subcommand is used as the canonical way of specifying just -arguments and calling **`just`** via **execvp(2)**. Any subsequent argument +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 @@ -234,7 +234,7 @@ rebuild). ------------------------------------------------------------------------------------------------------------- This subcommand is the explicit way of specifying *known* just -subcommands and calling **`just`** via **execvp(2)**. The same description +subcommands and calling **`just`** via **`execvp`**(2). The same description as for the **`do`** subcommand applies. EXIT STATUS @@ -253,12 +253,12 @@ 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 ======== -**just-mr-repository-config(5)**, -**just-repository-config(5)**, -**just(1)** +**`just-mr-repository-config`**(5), +**`just-repository-config`**(5), +**`just`**(1) diff --git a/share/man/just-mrrc.5.md b/share/man/just-mrrc.5.md index bce59b23..a3be61bf 100644 --- a/share/man/just-mrrc.5.md +++ b/share/man/just-mrrc.5.md @@ -4,7 +4,7 @@ NAME ==== just-mr configuration -- The format of the configuration used by -**just-mr(1)** +**`just-mr`**(1) DESCRIPTION =========== @@ -47,23 +47,23 @@ The just-mrrc is given by a JSON object. - The value for the key *`"config lookup order"`* is a JSON list of location objects, specifying where to look for multi-repository - configurations (see **just-mr-repository-config(5)** for more + configurations (see **`just-mr-repository-config`**(5) for more detail). The lookup is performed in the same order the location objects appear in the list. - The value for the key *`"local build root"`* is a single location object, specifying the path to use as the local build root. For more - details, see **just-mr(1)**. + details, see **`just-mr`**(1). - The value for the key *`"checkout locations"`* is a single location object, specifying the path to the file for checkout locations. For - more details, see **just-mr(1)**. + more details, see **`just-mr`**(1). - 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 the same order the location objects appear in the list. For more - details, see **just-mr(1)**. + 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 @@ -124,4 +124,5 @@ An example just-mrrc file could look like the following: See also ======== -**just-mr(1)**, **just-mr-repository-config(5)** +**`just-mr`**(1), +**`just-mr-repository-config`**(5) diff --git a/share/man/just-repository-config.5.md b/share/man/just-repository-config.5.md index 05e33c8b..672983b7 100644 --- a/share/man/just-repository-config.5.md +++ b/share/man/just-repository-config.5.md @@ -4,7 +4,7 @@ NAME ==== just repository config -- The format of the repository config used by -**just(1)** +**`just`**(1) DESCRIPTION =========== @@ -97,10 +97,12 @@ NOTES Although the repository configuration is human-readable and can be written by hand, in many cases it will be generated by an independent -tool. **just-mr(1)** is one such tool that can be used for configuration -generation, but not necessarily the only one. +tool. **`just-mr`**(1) is one such tool that can be used for +configuration generation, but not necessarily the only one. See also ======== -**just(1)**, **just-mr(1)**, **just-mr-repository-config(5)** +**`just`**(1), +**`just-mr`**(1), +**`just-mr-repository-config`**(5) diff --git a/share/man/just.1.md b/share/man/just.1.md index 13dfdedd..eac31d97 100644 --- a/share/man/just.1.md +++ b/share/man/just.1.md @@ -251,7 +251,7 @@ description. -------------- It allows for the building and staging of requested artifacts from a -well-defined *`GRAPH_FILE`*. See **just-graph-file(5)** for more +well-defined *`GRAPH_FILE`*. See **`just-graph-file`**(5) for more details. **`gc`** @@ -307,7 +307,7 @@ Supported by: analyse|build|describe|install|rebuild. **`-C`**, **`--repository-config`** *`PATH`* Path to configuration file for multi-repository builds. See -**just-repository-config(5)** for more details. +**`just-repository-config`**(5) for more details. Supported by: analyse|build|describe|install|rebuild|traverse. **`-D`**, **`--defines`** *`JSON`* @@ -356,8 +356,7 @@ Supported by: build|install|rebuild|traverse|execute. **`--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. +Supported by: build|install-cas|install|rebuild|traverse|gc|execute. **`--main`** *`NAME`* The repository to take the target from. @@ -405,7 +404,7 @@ Supported by: build|install|rebuild|traverse. **`--dump-graph`** *`PATH`* File path for writing the action graph description to. See -**just-graph-file(5)** for more details. +**`just-graph-file`**(5) for more details. Supported by: analyse|build|install|rebuild. **`-f`**, **`--log-file`** *`PATH`* @@ -616,7 +615,7 @@ description (as JSON object as well). **`-g`**, **`--graph-file`** *`TEXT`* *`[[REQUIRED]]`* Path of the file containing the description of the actions. See -**just-graph-file(5)** for more details. +**`just-graph-file`**(5) for more details. **`--git-cas`** *`TEXT`* Path to a git repository, containing blobs of potentially missing @@ -676,5 +675,5 @@ The exit status of **`just`** is one of the following values: See also ======== -**just-repository-config(5)**, -**just-mr(1)** +**`just-repository-config`**(5), +**`just-mr`**(1) |