(zilch lang go): document
Change-Id: I6a6a6964558b4fe2f96d78120b2e899f91d48c22
This commit is contained in:
parent
f0ce185d5c
commit
18f2887eba
13 changed files with 457 additions and 96 deletions
58
docs/modules/ROOT/pages/go/man.adoc
Normal file
58
docs/modules/ROOT/pages/go/man.adoc
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
= zilch-cli-go(1)
|
||||
Puck Meerburg
|
||||
v0.0.1
|
||||
:doctype: manpage
|
||||
:manmanual: ZILCH-CLI-GO
|
||||
:mansource: ZILCH
|
||||
:page-pagination: prev
|
||||
|
||||
== Name
|
||||
|
||||
zilch-cli-go - builds a Go module using Zilch
|
||||
|
||||
== Synopsis
|
||||
|
||||
*zilch-cli-go* [_OPTION_]... _PACKAGE_...
|
||||
|
||||
== Description
|
||||
|
||||
This command uses Zilch to build one or more Go packages entirely
|
||||
inside Nix, using content-addressed derivations.
|
||||
|
||||
A Go module is recognized by its `go.mod`, which contains information
|
||||
about the dependencies of any Go package. This versioning info is used
|
||||
identically to a normal `go build` call.
|
||||
|
||||
== 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_::
|
||||
*--module-dir* _DIR_::
|
||||
The directory to use as root module. All packages to be built must
|
||||
come from this module.
|
||||
|
||||
*-r* _DIR_::
|
||||
*--replace* _DIR_::
|
||||
Replace a module from the `go.mod` of the root module with
|
||||
this directory, based on the name of the replaced module's `go.mod`.
|
||||
Can be specified multiple times.
|
||||
|
||||
*--debug*::
|
||||
Crash on the first error, rather than continuing to build the next
|
||||
package.
|
||||
Loading…
Add table
Add a link
Reference in a new issue