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

Merge pull request #166 from jtcarnes/add-tags-documentation

Browse source 
docs(nix-reference): update docs to include additional parameters
This commit is contained in:
Marcus Ramberg 2024-09-05 07:55:22 +02:00 committed by GitHub
commit 1c6fd4e862
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
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 ## Public functions
### buildGoApplication ### buildGoApplication
Arguments: Arguments:
- **modules** Path to `gomod2nix.toml` (_default: `pwd + "/gomod2nix.toml"`).
- **src** Path to sources (_default: `pwd`). - **modules** Path to `gomod2nix.toml` (\_default: `pwd + "/gomod2nix.toml"`).
- **pwd** Path to working directory (_default: `null`). - **src** Path to sources (\_default: `pwd`).
- **pwd** Path to working directory (\_default: `null`).
- **go** The Go compiler to use (can be omitted). - **go** The Go compiler to use (can be omitted).
- **subPackages** Only build these specific sub packages. - **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`. All other arguments are passed verbatim to `stdenv.mkDerivation`.
### mkGoEnv ### mkGoEnv
Arguments: Arguments:
- **pwd** Path to working directory. - **pwd** Path to working directory.
- **modules** Path to `gomod2nix.toml` (_default: `pwd + "/gomod2nix.toml"`). - **modules** Path to `gomod2nix.toml` (\_default: `pwd + "/gomod2nix.toml"`).
- **toolsGo** Path to `tools.go` (_default: `pwd + "/tools.go"`). - **toolsGo** Path to `tools.go` (\_default: `pwd + "/tools.go"`).
All other arguments are passed verbatim to `stdenv.mkDerivation`. All other arguments are passed verbatim to `stdenv.mkDerivation`.