darkkirb/gomod2nix
1
0
Fork 0
forked from mirrors/gomod2nix
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: Add Nix API reference docs

Browse source
This commit is contained in:
adisbladis 2022-06-14 18:18:04 +08:00
parent 366c0e5a17
commit e3745a9b6f
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/nix-reference.md Normal file
View file

@ -0,0 +1,20 @@
# 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.
All other arguments are passed verbatim to `stdenv.mkDerivation`.