gomod2nix/docs/nix-reference.md
Martin Baillie 29f6eb7bd5
Parameterise modules file in mkGoEnv
This makes `mkGoEnv` more similar to `buildGoApplication`.

Signed-off-by: Martin Baillie <martin@baillie.id>
2022-09-26 19:58:36 +10:00

22 lines
804 B
Markdown

# Gomod2nix Nix API
## Public functions
### buildGoApplication
Arguments:
- **modules** Path to `gomod2nix.toml` (_default: `pwd + "/gomod2nix.toml"`).
- **src** Path to sources (_default: `pwd`).
- **pwd** Path to working directory (_default: `null`).
- **go** The Go compiler to use (can be omitted).
- **subPackages** Only build these specific sub packages.
- **allowGoReference** Allow references to the Go compiler in the output closure (_default: `false`).
All other arguments are passed verbatim to `stdenv.mkDerivation`.
### mkGoEnv
Arguments:
- **pwd** Path to working directory.
- **modules** Path to `gomod2nix.toml` (_default: `pwd + "/gomod2nix.toml"`).
- **toolsGo** Path to `tools.go` (_default: `pwd + "/tools.go"`).
All other arguments are passed verbatim to `stdenv.mkDerivation`.