diff options
author | Sascha Roloff <sascha.roloff@huawei.com> | 2023-06-20 11:28:28 +0200 |
---|---|---|
committer | Sascha Roloff <sascha.roloff@huawei.com> | 2023-06-23 18:51:01 +0200 |
commit | 903537d36fd3c5fa9a235eebf72e0e1d595bad00 (patch) | |
tree | c86534dbcc81c3676d88a48a28dd4bcb4cfaa2af /share/man/just-import-git.1.md | |
parent | 9d7a7d086783efe7d651e45c5125a743f00de263 (diff) | |
download | justbuild-903537d36fd3c5fa9a235eebf72e0e1d595bad00.tar.gz |
man pages: properly emphasize and quote arguments and other keywords in man pages
In order to consistently emphasize arguments and other keywords in man page as
well as markdown viewers, they should be wrapped in single asterisks and single
backticks like *`<argument>`*.
Diffstat (limited to 'share/man/just-import-git.1.md')
-rw-r--r-- | share/man/just-import-git.1.md | 44 |
1 files changed, 23 insertions, 21 deletions
diff --git a/share/man/just-import-git.1.md b/share/man/just-import-git.1.md index c93bda4d..f3d143be 100644 --- a/share/man/just-import-git.1.md +++ b/share/man/just-import-git.1.md @@ -9,28 +9,29 @@ configuration SYNOPSIS ======== -just-import-deps \[OPTIONS\] URL \[foreign repository name\] +just-import-deps \[*`OPTION`*\]... *`URL`* \[*`foreign repository name`*\] DESCRIPTION =========== 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 problem, -that a repository can refer to itself only as `"."` in a portable way. -The importing party, however, always knows the URL it is importing from. +repository are added as well and *`"file"`* repositories are transformed +to *`"subdir"`* parts of the imported repository. This solves the +problem, that a repository can refer to itself only as *`"."`* in a +portable way. The importing party, however, always knows the URL it is +importing from. The imported repositories are renamed in a way that no conflicts with already present repositories arise. The repositories pulled in as dependencies are named in a way to remind for which repositories they came as a dependency. This renaming is taken into account at all places -repositories are referred to, i.e., the `"bindings"` field, as well as +repositories are referred to, i.e., the *`"bindings"`* field, as well as roots defined by reference to other repositories. -Only the main parts of repositories are imported (`"repository"`, -`"bindings"`, names, and roots). The `"pragma"` part, as well as unknown -fields are dropped. +Only the main parts of repositories are imported (*`"repository"`*, +*`"bindings"`*, names, and roots). The *`"pragma"`* part, as well as +unknown fields are dropped. The repository to import is specified by its URL @@ -39,40 +40,41 @@ 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"`. +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`**. +*`-`* 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`** 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` 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. +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 |