(zilch lang rust): document
Change-Id: I6a6a6964c8aaff8d5f3e18bc5c7486746b5a2952
This commit is contained in:
parent
ae774da043
commit
0340f6e830
10 changed files with 597 additions and 82 deletions
63
docs/modules/ROOT/pages/rust/man.adoc
Normal file
63
docs/modules/ROOT/pages/rust/man.adoc
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
= zilch-cli-rust(1)
|
||||
Puck Meerburg
|
||||
v0.0.1
|
||||
:doctype: manpage
|
||||
:manmanual: ZILCH-CLI-RUST
|
||||
:mansource: ZILCH
|
||||
:page-pagination: prev
|
||||
|
||||
== Name
|
||||
|
||||
zilch-cli-rust - builds a Rust crate using Zilch
|
||||
|
||||
== Synopsis
|
||||
|
||||
*zilch-cli-rust* [_OPTION_]... [_TARGET_]...
|
||||
|
||||
== Description
|
||||
|
||||
This command uses Zilch to build one or more Rust crate targets
|
||||
entirely inside Nix, using content-addressed derivations.
|
||||
|
||||
This program requires a Rust crate consisting of a `Cargo.toml` and
|
||||
with a valid and up-to-date `Cargo.lock`.
|
||||
|
||||
== Options
|
||||
|
||||
*-h*::
|
||||
*--help*::
|
||||
Print a help message
|
||||
|
||||
*-j* _COUNT_::
|
||||
*--max-jobs* _COUNT_::
|
||||
The maximum amount of builds to run. Defaults to the amount of cores.
|
||||
|
||||
*-v*::
|
||||
*--verbose*::
|
||||
Increase the verbosity configured in the Nix daemon. Can be specified
|
||||
multiple times.
|
||||
|
||||
*-L*::
|
||||
*--print-build-logs*::
|
||||
Print derivation logs as they come in.
|
||||
|
||||
*-m* _DIR_::
|
||||
*--crate-dir* _DIR_::
|
||||
The directory to use as crate. This is also the crate that will be
|
||||
used to find viable targets to build.
|
||||
|
||||
*-r* _DIR_::
|
||||
*--replace* _DIR_::
|
||||
Add the crate in _DIR_ to the possible dependencies, prioritizing it
|
||||
over any crate in the `Cargo.lock`. Can be specified multiple times.
|
||||
|
||||
*-z* _PATH_::
|
||||
*--overrides* _PATH_::
|
||||
Read build script overrides from this file. By default, a stock set
|
||||
of overrides is used, aimed at some crates. If an empty string is
|
||||
used for _PATH_, this default set of overrides is not used. Can be
|
||||
specified multiple times.
|
||||
|
||||
*--debug*::
|
||||
Crash on the first error, rather than continuing to build the next
|
||||
target.
|
||||
Loading…
Add table
Add a link
Reference in a new issue