maurice/snix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore(nix/buildGo): drop buildGo.proto and buildGo.grpc

Browse source 
As described in  https://b.tvl.fyi/issues/221#comment-344, buildGo.proto was a
mistake and should be removed.

Change-Id: Ic588a5e8eea58e83e3ec9a37ac681ce526028718
Reviewed-on: https://cl.tvl.fyi/c/depot/+/7536
Reviewed-by: tazjin <tazjin@tvl.su>
Tested-by: BuildkiteCI
This commit is contained in:
Florian Klink 2022-12-06 15:13:22 +00:00 • committed by flokli
parent c6cb138565
commit 7fbac93940
3 changed files with 2 additions and 134 deletions
Download patch file Download diff file Expand all files Collapse all files

27
nix/buildGo/README.md
View file

@ -2,8 +2,7 @@ buildGo.nix
===========
This is an alternative [Nix][] build system for [Go][]. It supports building Go
libraries and programs, and even automatically generating Protobuf & gRPC
libraries.
libraries and programs.
*Note:* This will probably end up being folded into [Nixery][].
@ -33,7 +32,6 @@ Given a program layout like this:
├── lib <-- some library component
│   ├── bar.go
│   └── foo.go
├── api.proto <-- gRPC API definition
├── main.go <-- program implementation
└── default.nix <-- build instructions
```
@ -44,11 +42,6 @@ The contents of `default.nix` could look like this:
{ buildGo }:
let
api = buildGo.grpc {
name = "someapi";
proto = ./api.proto;
};
lib = buildGo.package {
name = "somelib";
srcs = [
@ -58,7 +51,7 @@ let
};
in buildGo.program {
name = "my-program";
deps = [ api lib ];
deps = [ lib ];
srcs = [
./main.go
@ -105,22 +98,6 @@ in buildGo.program {
| `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).
* `buildGo.proto`: Build a Go library out of the specified Protobuf definition.
| parameter | type | use | required? |
|-------------|-------------|--------------------------------------------------|-----------|
| `name` | `string` | Name for the resulting library | yes |
| `proto` | `path` | Path to the Protobuf definition file | yes |
| `path` | `string` | Import path for the resulting Go library | no |
| `extraDeps` | `list<drv>` | Additional Go dependencies to add to the library | no |
* `buildGo.grpc`: Build a Go library out of the specified gRPC definition.
The parameters are identical to `buildGo.proto`.
## Current status
This project is work-in-progress. Crucially it is lacking the following features: