From 73f88a6d4c65007eb90c781f45446f24805a3ec3 Mon Sep 17 00:00:00 2001 From: Brad Fitzpatrick Date: Wed, 2 Aug 2017 21:26:21 +0000 Subject: [PATCH] all: add README.md files where missing, and tool to keep them updated Change-Id: I385171c415bf168c04c6c3a7a996bff88964af84 Reviewed-on: https://go-review.googlesource.com/52856 Reviewed-by: Andrew Bonventre --- auth/README.md | 7 +++ autocertcache/README.md | 7 +++ buildenv/README.md | 7 +++ buildlet/README.md | 7 +++ cmd/builder/README.md | 7 +++ cmd/buildlet/stage0/README.md | 7 +++ cmd/buildstats/README.md | 7 +++ cmd/cl/README.md | 7 +++ cmd/coordinator/buildongce/README.md | 7 +++ cmd/coordinator/metrics/README.md | 7 +++ cmd/coordinator/spanlog/README.md | 7 +++ cmd/debugnewvm/README.md | 7 +++ cmd/docker2boot/README.md | 7 +++ cmd/fetchlogs/README.md | 7 +++ cmd/genbootstrap/README.md | 7 +++ cmd/gitlock/README.md | 7 +++ cmd/gitmirror/README.md | 7 +++ cmd/gomote/README.md | 7 +++ cmd/gopherbot/README.md | 7 +++ cmd/gopherstats/README.md | 7 +++ cmd/makemac/README.md | 7 +++ cmd/perfrun/README.md | 7 +++ cmd/pubsubhelper/pubsubtypes/README.md | 7 +++ cmd/racebuild/README.md | 7 +++ cmd/release/README.md | 7 +++ cmd/relnote/README.md | 7 +++ cmd/retrybuilds/README.md | 7 +++ cmd/rundockerbuildlet/README.md | 7 +++ cmd/scaleway/README.md | 7 +++ cmd/upload/README.md | 7 +++ dashboard/README.md | 7 +++ envutil/README.md | 7 +++ gerrit/README.md | 7 +++ internal/buildgo/README.md | 7 +++ internal/gophers/README.md | 7 +++ internal/httpdl/README.md | 7 +++ internal/loghash/README.md | 7 +++ internal/lru/README.md | 7 +++ internal/singleflight/README.md | 7 +++ internal/sourcecache/README.md | 7 +++ internal/untar/README.md | 7 +++ kubernetes/README.md | 7 +++ kubernetes/api/README.md | 7 +++ kubernetes/gke/README.md | 7 +++ livelog/README.md | 7 +++ maintner/README.md | 7 +++ maintner/godata/README.md | 7 +++ maintner/gostats/README.md | 7 +++ maintner/maintnerd/README.md | 7 +++ maintner/maintpb/README.md | 7 +++ maintner/maintq/README.md | 7 +++ maintner/reclog/README.md | 7 +++ maintner/slurpgit/README.md | 7 +++ pargzip/README.md | 7 +++ revdial/README.md | 7 +++ tarutil/README.md | 7 +++ types/README.md | 7 +++ update-readmes.go | 84 ++++++++++++++++++++++++++ 58 files changed, 483 insertions(+) create mode 100644 auth/README.md create mode 100644 autocertcache/README.md create mode 100644 buildenv/README.md create mode 100644 buildlet/README.md create mode 100644 cmd/builder/README.md create mode 100644 cmd/buildlet/stage0/README.md create mode 100644 cmd/buildstats/README.md create mode 100644 cmd/cl/README.md create mode 100644 cmd/coordinator/buildongce/README.md create mode 100644 cmd/coordinator/metrics/README.md create mode 100644 cmd/coordinator/spanlog/README.md create mode 100644 cmd/debugnewvm/README.md create mode 100644 cmd/docker2boot/README.md create mode 100644 cmd/fetchlogs/README.md create mode 100644 cmd/genbootstrap/README.md create mode 100644 cmd/gitlock/README.md create mode 100644 cmd/gitmirror/README.md create mode 100644 cmd/gomote/README.md create mode 100644 cmd/gopherbot/README.md create mode 100644 cmd/gopherstats/README.md create mode 100644 cmd/makemac/README.md create mode 100644 cmd/perfrun/README.md create mode 100644 cmd/pubsubhelper/pubsubtypes/README.md create mode 100644 cmd/racebuild/README.md create mode 100644 cmd/release/README.md create mode 100644 cmd/relnote/README.md create mode 100644 cmd/retrybuilds/README.md create mode 100644 cmd/rundockerbuildlet/README.md create mode 100644 cmd/scaleway/README.md create mode 100644 cmd/upload/README.md create mode 100644 dashboard/README.md create mode 100644 envutil/README.md create mode 100644 gerrit/README.md create mode 100644 internal/buildgo/README.md create mode 100644 internal/gophers/README.md create mode 100644 internal/httpdl/README.md create mode 100644 internal/loghash/README.md create mode 100644 internal/lru/README.md create mode 100644 internal/singleflight/README.md create mode 100644 internal/sourcecache/README.md create mode 100644 internal/untar/README.md create mode 100644 kubernetes/README.md create mode 100644 kubernetes/api/README.md create mode 100644 kubernetes/gke/README.md create mode 100644 livelog/README.md create mode 100644 maintner/README.md create mode 100644 maintner/godata/README.md create mode 100644 maintner/gostats/README.md create mode 100644 maintner/maintnerd/README.md create mode 100644 maintner/maintpb/README.md create mode 100644 maintner/maintq/README.md create mode 100644 maintner/reclog/README.md create mode 100644 maintner/slurpgit/README.md create mode 100644 pargzip/README.md create mode 100644 revdial/README.md create mode 100644 tarutil/README.md create mode 100644 types/README.md create mode 100644 update-readmes.go diff --git a/auth/README.md b/auth/README.md new file mode 100644 index 00000000..75e7cf71 --- /dev/null +++ b/auth/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/auth?status.svg)](https://godoc.org/golang.org/x/build/auth) + +# golang.org/x/build/auth + +Package auth contains shared code related to OAuth2 and obtaining tokens for a project. diff --git a/autocertcache/README.md b/autocertcache/README.md new file mode 100644 index 00000000..bd5ce149 --- /dev/null +++ b/autocertcache/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/autocertcache?status.svg)](https://godoc.org/golang.org/x/build/autocertcache) + +# golang.org/x/build/autocertcache + +Package autocertcache contains autocert.Cache implementations for golang.org/x/crypto/autocert. diff --git a/buildenv/README.md b/buildenv/README.md new file mode 100644 index 00000000..45de9b6f --- /dev/null +++ b/buildenv/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/buildenv?status.svg)](https://godoc.org/golang.org/x/build/buildenv) + +# golang.org/x/build/buildenv + +Package buildenv contains definitions for the environments the Go build system can run in. diff --git a/buildlet/README.md b/buildlet/README.md new file mode 100644 index 00000000..90b01e63 --- /dev/null +++ b/buildlet/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/buildlet?status.svg)](https://godoc.org/golang.org/x/build/buildlet) + +# golang.org/x/build/buildlet + +Package buildlet contains client tools for working with a buildlet server. diff --git a/cmd/builder/README.md b/cmd/builder/README.md new file mode 100644 index 00000000..0252fa15 --- /dev/null +++ b/cmd/builder/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/builder?status.svg)](https://godoc.org/golang.org/x/build/cmd/builder) + +# golang.org/x/build/cmd/builder + +The builder binary is the old continuous build client for the Go project. diff --git a/cmd/buildlet/stage0/README.md b/cmd/buildlet/stage0/README.md new file mode 100644 index 00000000..e8b781dc --- /dev/null +++ b/cmd/buildlet/stage0/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/buildlet/stage0?status.svg)](https://godoc.org/golang.org/x/build/cmd/buildlet/stage0) + +# golang.org/x/build/cmd/buildlet/stage0 + +The stage0 command looks up the buildlet's URL from its environment (GCE metadata service, scaleway, etc), downloads it, and runs it. diff --git a/cmd/buildstats/README.md b/cmd/buildstats/README.md new file mode 100644 index 00000000..8891b52b --- /dev/null +++ b/cmd/buildstats/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/buildstats?status.svg)](https://godoc.org/golang.org/x/build/cmd/buildstats) + +# golang.org/x/build/cmd/buildstats + +The buildstats command syncs build logs from Datastore to Bigquery. diff --git a/cmd/cl/README.md b/cmd/cl/README.md new file mode 100644 index 00000000..d4912872 --- /dev/null +++ b/cmd/cl/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/cl?status.svg)](https://godoc.org/golang.org/x/build/cmd/cl) + +# golang.org/x/build/cmd/cl + +CL prints a list of open Go code reviews (also known as change lists, or CLs). diff --git a/cmd/coordinator/buildongce/README.md b/cmd/coordinator/buildongce/README.md new file mode 100644 index 00000000..436be4fd --- /dev/null +++ b/cmd/coordinator/buildongce/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/coordinator/buildongce?status.svg)](https://godoc.org/golang.org/x/build/cmd/coordinator/buildongce) + +# golang.org/x/build/cmd/coordinator/buildongce + + diff --git a/cmd/coordinator/metrics/README.md b/cmd/coordinator/metrics/README.md new file mode 100644 index 00000000..c9978b32 --- /dev/null +++ b/cmd/coordinator/metrics/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/coordinator/metrics?status.svg)](https://godoc.org/golang.org/x/build/cmd/coordinator/metrics) + +# golang.org/x/build/cmd/coordinator/metrics + +Package metrics enumerates the set of Stackdriver metrics used by the Go build system. diff --git a/cmd/coordinator/spanlog/README.md b/cmd/coordinator/spanlog/README.md new file mode 100644 index 00000000..80512c88 --- /dev/null +++ b/cmd/coordinator/spanlog/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/coordinator/spanlog?status.svg)](https://godoc.org/golang.org/x/build/cmd/coordinator/spanlog) + +# golang.org/x/build/cmd/coordinator/spanlog + +Package spanlog provides span and event logger interfaces that are used by the build coordinator infrastructure. diff --git a/cmd/debugnewvm/README.md b/cmd/debugnewvm/README.md new file mode 100644 index 00000000..b320da0b --- /dev/null +++ b/cmd/debugnewvm/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/debugnewvm?status.svg)](https://godoc.org/golang.org/x/build/cmd/debugnewvm) + +# golang.org/x/build/cmd/debugnewvm + +The debugnewvm command creates and destroys a VM-based GCE buildlet with lots of logging for debugging. diff --git a/cmd/docker2boot/README.md b/cmd/docker2boot/README.md new file mode 100644 index 00000000..1cf9ac4b --- /dev/null +++ b/cmd/docker2boot/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/docker2boot?status.svg)](https://godoc.org/golang.org/x/build/cmd/docker2boot) + +# golang.org/x/build/cmd/docker2boot + +The docker2boot command converts a Docker image into a bootable GCE VM image. diff --git a/cmd/fetchlogs/README.md b/cmd/fetchlogs/README.md new file mode 100644 index 00000000..cf9615d9 --- /dev/null +++ b/cmd/fetchlogs/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/fetchlogs?status.svg)](https://godoc.org/golang.org/x/build/cmd/fetchlogs) + +# golang.org/x/build/cmd/fetchlogs + +Fetchlogs downloads build failure logs from the Go dashboard so they can be accessed and searched from the local file system. diff --git a/cmd/genbootstrap/README.md b/cmd/genbootstrap/README.md new file mode 100644 index 00000000..2fd01a22 --- /dev/null +++ b/cmd/genbootstrap/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/genbootstrap?status.svg)](https://godoc.org/golang.org/x/build/cmd/genbootstrap) + +# golang.org/x/build/cmd/genbootstrap + +The genbootstrap command prepares GO_BOOTSTRAP tarballs suitable for use on builders. diff --git a/cmd/gitlock/README.md b/cmd/gitlock/README.md new file mode 100644 index 00000000..9683f58c --- /dev/null +++ b/cmd/gitlock/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/gitlock?status.svg)](https://godoc.org/golang.org/x/build/cmd/gitlock) + +# golang.org/x/build/cmd/gitlock + +The gitlock command helps write Dockerfiles with a bunch of lines to lock git dependencies in place. diff --git a/cmd/gitmirror/README.md b/cmd/gitmirror/README.md new file mode 100644 index 00000000..e6584e21 --- /dev/null +++ b/cmd/gitmirror/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/gitmirror?status.svg)](https://godoc.org/golang.org/x/build/cmd/gitmirror) + +# golang.org/x/build/cmd/gitmirror + +The gitmirror binary watches the specified Gerrit repositories for new commits and reports them to the build dashboard. diff --git a/cmd/gomote/README.md b/cmd/gomote/README.md new file mode 100644 index 00000000..55f64093 --- /dev/null +++ b/cmd/gomote/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/gomote?status.svg)](https://godoc.org/golang.org/x/build/cmd/gomote) + +# golang.org/x/build/cmd/gomote + +The gomote command is a client for the Go builder infrastructure. diff --git a/cmd/gopherbot/README.md b/cmd/gopherbot/README.md new file mode 100644 index 00000000..43c858ed --- /dev/null +++ b/cmd/gopherbot/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/gopherbot?status.svg)](https://godoc.org/golang.org/x/build/cmd/gopherbot) + +# golang.org/x/build/cmd/gopherbot + +The gopherbot command runs Go's gopherbot role account on GitHub and Gerrit. diff --git a/cmd/gopherstats/README.md b/cmd/gopherstats/README.md new file mode 100644 index 00000000..1987c48a --- /dev/null +++ b/cmd/gopherstats/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/gopherstats?status.svg)](https://godoc.org/golang.org/x/build/cmd/gopherstats) + +# golang.org/x/build/cmd/gopherstats + + diff --git a/cmd/makemac/README.md b/cmd/makemac/README.md new file mode 100644 index 00000000..3f21f1c9 --- /dev/null +++ b/cmd/makemac/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/makemac?status.svg)](https://godoc.org/golang.org/x/build/cmd/makemac) + +# golang.org/x/build/cmd/makemac + +The makemac command starts OS X VMs for the builders. diff --git a/cmd/perfrun/README.md b/cmd/perfrun/README.md new file mode 100644 index 00000000..ca9cc8ae --- /dev/null +++ b/cmd/perfrun/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/perfrun?status.svg)](https://godoc.org/golang.org/x/build/cmd/perfrun) + +# golang.org/x/build/cmd/perfrun + +perfrun interacts with the buildlet coordinator to run the go1 benchmarks on a buildlet slave for the most recent successful commits according to the build dashboard. diff --git a/cmd/pubsubhelper/pubsubtypes/README.md b/cmd/pubsubhelper/pubsubtypes/README.md new file mode 100644 index 00000000..5858b95f --- /dev/null +++ b/cmd/pubsubhelper/pubsubtypes/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/pubsubhelper/pubsubtypes?status.svg)](https://godoc.org/golang.org/x/build/cmd/pubsubhelper/pubsubtypes) + +# golang.org/x/build/cmd/pubsubhelper/pubsubtypes + +Package pubsubtypes contains types published by pubsubhelper. diff --git a/cmd/racebuild/README.md b/cmd/racebuild/README.md new file mode 100644 index 00000000..38a0efb5 --- /dev/null +++ b/cmd/racebuild/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/racebuild?status.svg)](https://godoc.org/golang.org/x/build/cmd/racebuild) + +# golang.org/x/build/cmd/racebuild + +racebuild builds the race runtime (syso files) on all supported OSes using gomote. diff --git a/cmd/release/README.md b/cmd/release/README.md new file mode 100644 index 00000000..9150c7af --- /dev/null +++ b/cmd/release/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/release?status.svg)](https://godoc.org/golang.org/x/build/cmd/release) + +# golang.org/x/build/cmd/release + +Command release builds a Go release. diff --git a/cmd/relnote/README.md b/cmd/relnote/README.md new file mode 100644 index 00000000..c8fa789e --- /dev/null +++ b/cmd/relnote/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/relnote?status.svg)](https://godoc.org/golang.org/x/build/cmd/relnote) + +# golang.org/x/build/cmd/relnote + +The relnote command summarizes the Go changes in Gerrit marked with RELNOTE annotations for the release notes. diff --git a/cmd/retrybuilds/README.md b/cmd/retrybuilds/README.md new file mode 100644 index 00000000..e1d3d210 --- /dev/null +++ b/cmd/retrybuilds/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/retrybuilds?status.svg)](https://godoc.org/golang.org/x/build/cmd/retrybuilds) + +# golang.org/x/build/cmd/retrybuilds + +The retrybuilds command clears build failures from the build.golang.org dashboard to force them to be rebuilt. diff --git a/cmd/rundockerbuildlet/README.md b/cmd/rundockerbuildlet/README.md new file mode 100644 index 00000000..3b0fc7fb --- /dev/null +++ b/cmd/rundockerbuildlet/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/rundockerbuildlet?status.svg)](https://godoc.org/golang.org/x/build/cmd/rundockerbuildlet) + +# golang.org/x/build/cmd/rundockerbuildlet + +The rundockerbuildlet command loops forever and creates and cleans up Docker containers running reverse buildlets. diff --git a/cmd/scaleway/README.md b/cmd/scaleway/README.md new file mode 100644 index 00000000..f475271e --- /dev/null +++ b/cmd/scaleway/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/scaleway?status.svg)](https://godoc.org/golang.org/x/build/cmd/scaleway) + +# golang.org/x/build/cmd/scaleway + +The scaleway command creates ARM servers on Scaleway.com. diff --git a/cmd/upload/README.md b/cmd/upload/README.md new file mode 100644 index 00000000..d7e4e8d1 --- /dev/null +++ b/cmd/upload/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/cmd/upload?status.svg)](https://godoc.org/golang.org/x/build/cmd/upload) + +# golang.org/x/build/cmd/upload + +The upload command writes a file to Google Cloud Storage. diff --git a/dashboard/README.md b/dashboard/README.md new file mode 100644 index 00000000..075410df --- /dev/null +++ b/dashboard/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/dashboard?status.svg)](https://godoc.org/golang.org/x/build/dashboard) + +# golang.org/x/build/dashboard + +Package dashboard contains shared configuration and logic used by various pieces of the Go continuous build system. diff --git a/envutil/README.md b/envutil/README.md new file mode 100644 index 00000000..8c36481e --- /dev/null +++ b/envutil/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/envutil?status.svg)](https://godoc.org/golang.org/x/build/envutil) + +# golang.org/x/build/envutil + +Package envutil provides utilities for working with environment variables. diff --git a/gerrit/README.md b/gerrit/README.md new file mode 100644 index 00000000..f6376cca --- /dev/null +++ b/gerrit/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/gerrit?status.svg)](https://godoc.org/golang.org/x/build/gerrit) + +# golang.org/x/build/gerrit + +Package gerrit contains code to interact with Gerrit servers. diff --git a/internal/buildgo/README.md b/internal/buildgo/README.md new file mode 100644 index 00000000..b76a367d --- /dev/null +++ b/internal/buildgo/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/internal/buildgo?status.svg)](https://godoc.org/golang.org/x/build/internal/buildgo) + +# golang.org/x/build/internal/buildgo + +Package buildgo provides tools for pushing and building the Go distribution on buildlets. diff --git a/internal/gophers/README.md b/internal/gophers/README.md new file mode 100644 index 00000000..cb126449 --- /dev/null +++ b/internal/gophers/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/internal/gophers?status.svg)](https://godoc.org/golang.org/x/build/internal/gophers) + +# golang.org/x/build/internal/gophers + +Package gophers is a list of names, emails, and Github usernames of people from the Go git repos and issue trackers. diff --git a/internal/httpdl/README.md b/internal/httpdl/README.md new file mode 100644 index 00000000..7551ea8a --- /dev/null +++ b/internal/httpdl/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/internal/httpdl?status.svg)](https://godoc.org/golang.org/x/build/internal/httpdl) + +# golang.org/x/build/internal/httpdl + +Package httpdl downloads things from HTTP to local disk. diff --git a/internal/loghash/README.md b/internal/loghash/README.md new file mode 100644 index 00000000..21c3564c --- /dev/null +++ b/internal/loghash/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/internal/loghash?status.svg)](https://godoc.org/golang.org/x/build/internal/loghash) + +# golang.org/x/build/internal/loghash + +Package loghash provides the shared information for computing a log hash (as in https://build.golang.org/log/HASH). diff --git a/internal/lru/README.md b/internal/lru/README.md new file mode 100644 index 00000000..ddbf3646 --- /dev/null +++ b/internal/lru/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/internal/lru?status.svg)](https://godoc.org/golang.org/x/build/internal/lru) + +# golang.org/x/build/internal/lru + +Package lru implements an LRU cache. diff --git a/internal/singleflight/README.md b/internal/singleflight/README.md new file mode 100644 index 00000000..a0ced119 --- /dev/null +++ b/internal/singleflight/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/internal/singleflight?status.svg)](https://godoc.org/golang.org/x/build/internal/singleflight) + +# golang.org/x/build/internal/singleflight + +Package singleflight provides a duplicate function call suppression mechanism. diff --git a/internal/sourcecache/README.md b/internal/sourcecache/README.md new file mode 100644 index 00000000..84960eb3 --- /dev/null +++ b/internal/sourcecache/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/internal/sourcecache?status.svg)](https://godoc.org/golang.org/x/build/internal/sourcecache) + +# golang.org/x/build/internal/sourcecache + +Package sourcecache provides a cache of code found in Git repositories. diff --git a/internal/untar/README.md b/internal/untar/README.md new file mode 100644 index 00000000..3eafec4b --- /dev/null +++ b/internal/untar/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/internal/untar?status.svg)](https://godoc.org/golang.org/x/build/internal/untar) + +# golang.org/x/build/internal/untar + +Package untar untars a tarball to disk. diff --git a/kubernetes/README.md b/kubernetes/README.md new file mode 100644 index 00000000..29218539 --- /dev/null +++ b/kubernetes/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/kubernetes?status.svg)](https://godoc.org/golang.org/x/build/kubernetes) + +# golang.org/x/build/kubernetes + +Package kubernetes contains a minimal client for the Kubernetes API. diff --git a/kubernetes/api/README.md b/kubernetes/api/README.md new file mode 100644 index 00000000..315526a7 --- /dev/null +++ b/kubernetes/api/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/kubernetes/api?status.svg)](https://godoc.org/golang.org/x/build/kubernetes/api) + +# golang.org/x/build/kubernetes/api + +Package api contains the Kubernetes v1 API types. diff --git a/kubernetes/gke/README.md b/kubernetes/gke/README.md new file mode 100644 index 00000000..ae21cd54 --- /dev/null +++ b/kubernetes/gke/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/kubernetes/gke?status.svg)](https://godoc.org/golang.org/x/build/kubernetes/gke) + +# golang.org/x/build/kubernetes/gke + +Package gke contains code for interacting with Google Container Engine (GKE), the hosted version of Kubernetes on Google Cloud Platform. diff --git a/livelog/README.md b/livelog/README.md new file mode 100644 index 00000000..195cff73 --- /dev/null +++ b/livelog/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/livelog?status.svg)](https://godoc.org/golang.org/x/build/livelog) + +# golang.org/x/build/livelog + +Package livelog provides a buffer that can be simultaneously written to by one writer and read from by many readers. diff --git a/maintner/README.md b/maintner/README.md new file mode 100644 index 00000000..7e8e92ff --- /dev/null +++ b/maintner/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/maintner?status.svg)](https://godoc.org/golang.org/x/build/maintner) + +# golang.org/x/build/maintner + +Package maintner mirrors, searches, syncs, and serves Git, Github, and Gerrit metadata. diff --git a/maintner/godata/README.md b/maintner/godata/README.md new file mode 100644 index 00000000..b136a60d --- /dev/null +++ b/maintner/godata/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/maintner/godata?status.svg)](https://godoc.org/golang.org/x/build/maintner/godata) + +# golang.org/x/build/maintner/godata + +Package godata loads the Go project's corpus of Git, Github, and Gerrit activity into memory to allow easy analysis without worrying about APIs and their pagination, quotas, and other nuisances and limitations. diff --git a/maintner/gostats/README.md b/maintner/gostats/README.md new file mode 100644 index 00000000..d5731bc8 --- /dev/null +++ b/maintner/gostats/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/maintner/gostats?status.svg)](https://godoc.org/golang.org/x/build/maintner/gostats) + +# golang.org/x/build/maintner/gostats + +The gostats command computes stats about the Go project. diff --git a/maintner/maintnerd/README.md b/maintner/maintnerd/README.md new file mode 100644 index 00000000..6428651b --- /dev/null +++ b/maintner/maintnerd/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/maintner/maintnerd?status.svg)](https://godoc.org/golang.org/x/build/maintner/maintnerd) + +# golang.org/x/build/maintner/maintnerd + +The maintnerd command serves project maintainer data from Git, Github, and/or Gerrit. diff --git a/maintner/maintpb/README.md b/maintner/maintpb/README.md new file mode 100644 index 00000000..0fb8aff9 --- /dev/null +++ b/maintner/maintpb/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/maintner/maintpb?status.svg)](https://godoc.org/golang.org/x/build/maintner/maintpb) + +# golang.org/x/build/maintner/maintpb + +Package maintpb is a generated protocol buffer package. diff --git a/maintner/maintq/README.md b/maintner/maintq/README.md new file mode 100644 index 00000000..58c78830 --- /dev/null +++ b/maintner/maintq/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/maintner/maintq?status.svg)](https://godoc.org/golang.org/x/build/maintner/maintq) + +# golang.org/x/build/maintner/maintq + +The maintq command queries a maintnerd gRPC server. diff --git a/maintner/reclog/README.md b/maintner/reclog/README.md new file mode 100644 index 00000000..f3cd677b --- /dev/null +++ b/maintner/reclog/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/maintner/reclog?status.svg)](https://godoc.org/golang.org/x/build/maintner/reclog) + +# golang.org/x/build/maintner/reclog + +Package reclog contains readers and writers for a record wrapper format used by maintner. diff --git a/maintner/slurpgit/README.md b/maintner/slurpgit/README.md new file mode 100644 index 00000000..bdc34e2d --- /dev/null +++ b/maintner/slurpgit/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/maintner/slurpgit?status.svg)](https://godoc.org/golang.org/x/build/maintner/slurpgit) + +# golang.org/x/build/maintner/slurpgit + + diff --git a/pargzip/README.md b/pargzip/README.md new file mode 100644 index 00000000..5872dbb8 --- /dev/null +++ b/pargzip/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/pargzip?status.svg)](https://godoc.org/golang.org/x/build/pargzip) + +# golang.org/x/build/pargzip + +Package pargzip contains a parallel gzip writer implementation. diff --git a/revdial/README.md b/revdial/README.md new file mode 100644 index 00000000..fdf1af84 --- /dev/null +++ b/revdial/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/revdial?status.svg)](https://godoc.org/golang.org/x/build/revdial) + +# golang.org/x/build/revdial + +Package revdial implements a Dialer and Listener which work together to turn an accepted connection (for instance, a Hijacked HTTP request) into a Dialer which can then create net.Conns connecting back to the original dialer, which then gets a net.Listener accepting those conns. diff --git a/tarutil/README.md b/tarutil/README.md new file mode 100644 index 00000000..a2ef8a22 --- /dev/null +++ b/tarutil/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/tarutil?status.svg)](https://godoc.org/golang.org/x/build/tarutil) + +# golang.org/x/build/tarutil + +Package tarutil contains utilities for working with tar archives. diff --git a/types/README.md b/types/README.md new file mode 100644 index 00000000..fd50331e --- /dev/null +++ b/types/README.md @@ -0,0 +1,7 @@ + + +[![GoDoc](https://godoc.org/golang.org/x/build/types?status.svg)](https://godoc.org/golang.org/x/build/types) + +# golang.org/x/build/types + +Package types contains common types used by the Go continuous build system. diff --git a/update-readmes.go b/update-readmes.go new file mode 100644 index 00000000..621015e6 --- /dev/null +++ b/update-readmes.go @@ -0,0 +1,84 @@ +// Copyright 2017 The Go Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// +build ignore + +// The update-readmes.go tool creates or updates README.md files in +// the golang.org/x/build tree. It only updates files if they are +// missing or were previously generated by this tool. +// +// The auto-generated Markdown contains the package doc synopsis +// and a link to godoc.org for the API reference. +package main + +import ( + "bytes" + "fmt" + "go/build" + "io/ioutil" + "log" + "os" + "path/filepath" + "strings" +) + +func main() { + root, err := build.Import("golang.org/x/build", "", build.FindOnly) + if err != nil { + log.Fatalf("failed to find golang.org/x/build root: %v", err) + } + err = filepath.Walk(root.Dir, func(path string, fi os.FileInfo, err error) error { + if err != nil { + return err + } + if !fi.IsDir() { + return nil + } + rest := strings.TrimPrefix(strings.TrimPrefix(path, root.Dir), "/") + switch rest { + case "env", "version", "vendor": + return filepath.SkipDir + } + pkgName := "golang.org/x/build/" + filepath.ToSlash(rest) + + pkg, err := build.Import(pkgName, "", 0) + if err != nil { + // Skip. + return nil + } + if _, err := os.Stat(filepath.Join(pkg.Dir, "README")); err == nil { + // Directory has exiting README; don't touch. + return nil + } + readmePath := filepath.Join(pkg.Dir, "README.md") + exist, err := ioutil.ReadFile(readmePath) + if err != nil && !os.IsNotExist(err) { + // A real error. + return err + } + const header = "Auto-generated by x/build/update-readmes.go" + if len(exist) > 0 && !bytes.Contains(exist, []byte(header)) { + return nil + } + newContents := []byte(fmt.Sprintf(` + +[![GoDoc](https://godoc.org/%s?status.svg)](https://godoc.org/%s) + +# %s + +%s +`, header, pkgName, pkgName, pkgName, pkg.Doc)) + if bytes.Equal(exist, newContents) { + return nil + } + if err := ioutil.WriteFile(readmePath, newContents, 0644); err != nil { + return err + } + log.Printf("Wrote %s", readmePath) + return nil + }) + if err != nil { + log.Fatal(err) + } +}