merge

cmd/go-cloud-debug-agent/internal/debug/dwarf/frame_test.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build linux
+
 package dwarf_test
 
 import (

cmd/go-cloud-debug-agent/internal/debug/dwarf/pclntab_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// +build go1.10
+// +build linux,go1.10
 
 package dwarf_test
 

cmd/go-cloud-debug-agent/internal/debug/gosym/pclntab_test.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build linux
+
 package gosym
 
 import (

cmd/go-cloud-debug-agent/internal/debug/remote/remote.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build linux
+
 // Package remote provides remote access to a debugproxy server.
 package remote
 

httpreplay/cmd/httpr/integration_test.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build linux
+
 package main_test
 
 import (

internal/gapicgen/cmd/genbot/README.md

@@ -16,8 +16,10 @@ information on how that's done can be found here:
 Note: this may change your `~/.gitconfig`, `~/.gitcookies`, and use up
 non-trivial amounts of space on your computer.
 
-1. Make sure you have all the tools installed listed in genlocal's README.md
-2. Run:
+1. Make sure you are on a non-Windows platform. If you are using windows
+   continue on to the docker instructions.
+2. Make sure you have all the tools installed listed in genlocal's README.md
+3. Run:
 
 ```shell
 cd /path/to/internal/gapicgen

internal/gapicgen/cmd/genbot/generate.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build !windows
+
 package main
 
 import (

internal/gapicgen/cmd/genbot/github.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build !windows
+
 package main
 
 import (

internal/gapicgen/cmd/genbot/main.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build !windows
+
 // genbot is a binary for generating gapics and creating CLs/PRs with the results.
 // It is intended to be used as a bot, though it can be run locally too.
 package main

internal/gapicgen/cmd/genbot/update.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build !windows
+
 package main
 
 import (

internal/gapicgen/cmd/genlocal/README.md

@@ -6,25 +6,29 @@ run generators against googleapis-private, and various other local tasks.
 
 ## Required tools
 
-1. Install [docker](https://www.docker.com/get-started)
+*Note*: If you are on a Windows platform you will need to install these tools
+in a linux docker container: [Install docker](https://www.docker.com/get-started)
+
 1. Install [protoc](https://github.com/protocolbuffers/protobuf/releases)
-1. Install [Go](http://golang.org/dl)
-1. Install python3, pip3
-1. Install virtualenv `pip3 install virtualenv`
-1. Install Go tools:
-
-    ```
-    go get \
-        github.com/golang/protobuf/protoc-gen-go \
-        golang.org/x/lint/golint \
-        golang.org/x/tools/cmd/goimports \
-        honnef.co/go/tools/cmd/staticcheck \
-        github.com/googleapis/gapic-generator-go/cmd/protoc-gen-go_gapic
-    ```
+2. Install [Go](http://golang.org/dl)
+3. Install python3, pip3
+4. Install virtualenv `pip3 install virtualenv`
+5. Install Go tools:
+
+```bash
+go get \
+    github.com/golang/protobuf/protoc-gen-go \
+    golang.org/x/lint/golint \
+    golang.org/x/tools/cmd/goimports \
+    honnef.co/go/tools/cmd/staticcheck \
+    github.com/googleapis/gapic-generator-go/cmd/protoc-gen-go_gapic
+```
 
 ## Running
 
-```
-cd /path/to/internal/gapicgen
+`git clone` this project if you don't already have it checked-out locally.
+
+```bash
+cd /path/to/google-cloud-go/internal/gapicgen
 go run cloud.google.com/go/internal/gapicgen/cmd/genlocal
-```
+```

internal/gapicgen/cmd/genlocal/main.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build !windows
+
 // genlocal is a binary for generating gapics locally. It may be used to test out
 // new changes, test the generation of a new library, test new generator tweaks,
 // run generators against googleapis-private, and various other local tasks.

internal/gapicgen/generator/generator.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build !windows
+
 // Package generator provides tools for generating clients.
 package generator
 

internal/gapicgen/tools.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build !windows
+
 // Package gapicgen provides some helpers for gapicgen binaries.
 package gapicgen
 

internal/godocfx/main.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// +build go1.15
+// +build linux,go1.15
 
 /*Command godocfx generates DocFX YAML for Go code.
 

internal/pretty/diff.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build linux
+
 package pretty
 
 import (

profiler/integration_test.go

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// +build linux
+
 package profiler
 
 import (

pubsublite/README.md

@@ -1,6 +1,76 @@
-## Cloud Pub/Sub Lite [![GoDoc](https://godoc.org/cloud.google.com/go/pubsublite?status.svg)](https://godoc.org/cloud.google.com/go/pubsublite)
+## Cloud Pub/Sub Lite [![GoDoc](https://godoc.org/cloud.google.com/go/pubsublite?status.svg)](https://pkg.go.dev/cloud.google.com/go/pubsublite)
 
-- [About Cloud Pub/Sub Lite](https://cloud.google.com/pubsub/lite/docs)
+- [About Cloud Pub/Sub Lite](https://cloud.google.com/pubsub/lite)
+- [Client library documentation](https://cloud.google.com/pubsub/lite/docs/reference/libraries)
+- [API documentation](https://cloud.google.com/pubsub/lite/docs/apis)
+- [Go client documentation](https://pkg.go.dev/cloud.google.com/go/pubsublite)
 
-*This library is under development and will not provide a delightful user
-experience until v1.0.0 has been released.*
+*This library is in ALPHA. Backwards-incompatible changes may be made before
+ stable v1.0.0 is released.*
+
+### Example Usage
+
+[snip]:# (imports)
+```go
+import (
+	"cloud.google.com/go/pubsub"
+	"cloud.google.com/go/pubsublite"
+	"cloud.google.com/go/pubsublite/ps"
+)
+```
+
+To publish messages to a topic:
+
+[snip]:# (publish)
+```go
+// Create a PublisherClient for topic1.
+// See https://cloud.google.com/pubsub/lite/docs/locations for available zones.
+topic := pubsublite.TopicPath{
+    Project: "project-id",
+    Zone:    "us-central1-b",
+    TopicID: "topic1",
+}
+publisher, err := ps.NewPublisherClient(ctx, ps.DefaultPublishSettings, topic)
+if err != nil {
+    log.Fatal(err)
+}
+
+// Publish "hello world".
+res := publisher.Publish(ctx, &pubsub.Message{
+	Data: []byte("hello world"),
+})
+// The publish happens asynchronously.
+// Later, you can get the result from res:
+...
+msgID, err := res.Get(ctx)
+if err != nil {
+	log.Fatal(err)
+}
+```
+
+To receive messages for a subscription:
+
+[snip]:# (subscribe)
+```go
+// Create a SubscriberClient for subscription1.
+subscription := pubsublite.SubscriptionPath{
+    Project:        "project-id",
+    Zone:           "us-central1-b",
+    SubscriptionID: "subscription1",
+}
+subscriber, err := ps.NewSubscriberClient(ctx, ps.DefaultReceiveSettings, subscription)
+if err != nil {
+	log.Fatal(err)
+}
+
+// Use a callback to receive messages.
+// Call cancel() to stop receiving messages.
+cctx, cancel := context.WithCancel(ctx)
+err = subscriber.Receive(cctx, func(ctx context.Context, m *pubsub.Message) {
+	fmt.Println(m.Data)
+	m.Ack() // Acknowledge that we've consumed the message.
+})
+if err != nil {
+	log.Println(err)
+}
+```