mirrors/gomod2nix
1
0
Fork 1
mirror of https://github.com/tweag/gomod2nix.git synced 2024-11-21 20:55:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs(nix-reference): update docs to include additional parameters

Browse source 
there were additional nix parameters available during build that were
undocumented. This documents them to make them easier to see and use.
This commit is contained in:
Joshua Carnes 2024-08-04 18:12:55 -04:00
parent 4e08ca0925
commit f2f936b454
No known key found for this signature in database
1 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/nix-reference.md
View file

@ -3,20 +3,27 @@
## 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`).
- **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`).
- **allowGoReference** Allow references to the Go compiler in the output closure (\_default: `false`).
- **tags** A list of tags to pass the Go compiler during the build (\_default: `[ ]`).
- **ldflags** A list of `ldflags` to pass the Go compiler during the build (\_default: `[ ]`).
- **nativeBuildInputs** A list of packages to include in the build derivation (\_default: `[ ]`).
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"`).
- **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`.