summaryrefslogtreecommitdiff
path: root/share/man/import-cargo.1.md
diff options
context:
space:
mode:
authorAlberto Sartori <alberto.sartori@huawei.com>2024-06-24 15:49:36 +0200
committerKlaus Aehlig <klaus.aehlig@huawei.com>2024-06-24 15:49:36 +0200
commitf87ad41f72ca4465a0c5b4ba9fd36a7b09e4d4f4 (patch)
tree24d4a3a5975df2046714c6bc114d5d050bdc61fc /share/man/import-cargo.1.md
downloadrules-rust-f87ad41f72ca4465a0c5b4ba9fd36a7b09e4d4f4.tar.gz
Initial commit
Co-authored-by: Klaus Aehlig <klaus.aehlig@huawei.com>
Diffstat (limited to 'share/man/import-cargo.1.md')
-rw-r--r--share/man/import-cargo.1.md75
1 files changed, 75 insertions, 0 deletions
diff --git a/share/man/import-cargo.1.md b/share/man/import-cargo.1.md
new file mode 100644
index 0000000..d52aece
--- /dev/null
+++ b/share/man/import-cargo.1.md
@@ -0,0 +1,75 @@
+% JUST-IMPORT-CARGO(1) | General Commands Manual
+
+NAME
+====
+
+just-import-cargo - import the cargo dependencies of one crate
+
+SYNOPSIS
+========
+
+**`just-import-cargo`** \[*`OPTION`*]... *`relative-crate-location`*
+
+DESCRIPTION
+===========
+
+Given a physical repository where one sudirectory has the file
+layout of a crate and a **`just-mr-repository-config`**(5) on
+standard input,
+ - extend the repository configuration by a logical repsitory for
+ that cate, as well as logical repositories for all the transitive
+ dependencies as reported by **`cargo`**(1) when asked for the
+ development dependencies of the given crate,
+ - generate the needed target files in the directory *`etc/deps-rust`*
+ of the physical repository, and
+ - add appropriate rust default targets in the directory *`etc/defaults`*
+ of the physical repository.
+
+OPTIONS
+=======
+
+**`-h`**, **`--help`**
+Output a usage message and exit.
+
+**`--rules`** *`name`*
+Assume the rust rules are the logical repository *`name`* in the
+configuration provided on standard input. Typically, the rust rules
+would be imported first via **`just-import-git`**(1). If this option
+is not given, as last resort, a *`"file"`* repository for the rules
+is created pointing to the directory `../rules` relative to location
+of this binary. This is correct, if **`just-import-cargo`** is called
+from a (persistent) checkout of `rules-rust`, but hardly ever useful.
+
+**`--repo-root`** *`root`*
+Specify the root of the physical directory the configuration read from
+standard input refers to. If not given, it is assumed that the current
+working directory is the root of the physical repository.
+
+**`--local-crate-cache`** *`cache-root`*
+Specify the location where to cache the information about non-local crates.
+If not given, `~/.cache/crate-index-just` is used.
+
+**`-g`**, **`--to-git`**
+Add the `"to_git"` pragma to the generated repositories that are non
+content-fixed anyway.
+
+**`-t`**, **`--recompute-targets`**
+Recompute all target files, even if cached.
+
+**`-r`**, **`--recomptue-repos`**
+Recompute all repositories, even if cached.
+
+**`-s`**, **`--recompute-sources`**
+Recompute all source descriptions, even if cached.
+
+**`-I`**, **`--compute-index`**
+Add an index repository.
+
+See also
+========
+
+**`cargo`**(1),
+**`just-deduplicate-repos`**(1),
+**`just-import-git`**(1),
+**`just-mr-repository-config`**(5),
+**`just-mr`**(1)