diff options
| author | Vincent Ambo <tazjin@google.com> | 2019-12-13T00·12+0000 |
|---|---|---|
| committer | Vincent Ambo <mail@tazj.in> | 2019-12-13T00·39+0000 |
| commit | 9d5417501b1bdf5f363221a14b2e2a92ef2ba3e2 (patch) | |
| tree | 889b420acecbf38ce74e99a793ca116fd7d9b0b3 | |
| parent | 369c86e0ef8a713d47c2a6b94a3f70d527b84a3c (diff) | |
docs(README): Update description of buildGo.external
| -rw-r--r-- | README.md | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/README.md b/README.md index 489cf128173f..e84ede663bf8 100644 --- a/README.md +++ b/README.md @@ -90,19 +90,20 @@ in buildGo.program { | `deps` | `list<drv>` | List of dependencies (i.e. other Go libraries) | no | | `path` | `string` | Go import path for the resulting library | no | -* `buildGo.external`: Build a Go library or program using standard `go` tooling. - - This exists for compatibility with complex external dependencies. In theory it - is possible to write `buildGo.package` specifications for each subpackage of - an external dependency, but it is often cumbersome to do so. - - | parameter | type | use | required? | - |-----------|----------------|------------------------------------------------|-----------| - | `path` | `string` | Go import path for the resulting library | yes | - | `src` | `path` | Path to the source **directory** | yes | - | `deps` | `list<drv>` | List of dependencies (i.e. other Go libraries) | no | - | `srcOnly` | `bool` | Only copy sources, do not perform a build. | no | - | `targets` | `list<string>` | Sub-packages to build (defaults to all) | no | +* `buildGo.external`: Build an externally defined Go library or program. + + This function performs analysis on the supplied source code (which + can use the standard Go tooling layout) and creates a tree of all + the packages contained within. + + This exists for compatibility with external libraries that were not + defined using buildGo. + + | parameter | type | use | required? | + |-----------|----------------|-----------------------------------------------|-----------| + | `path` | `string` | Go import path for the resulting package | yes | + | `src` | `path` | Path to the source **directory** | yes | + | `deps` | `list<drv>` | List of dependencies (i.e. other Go packages) | no | For some examples of how `buildGo.external` is used, check out [`proto.nix`](./proto.nix). |