Skip to content

Commit

Permalink
all: add README.md files where missing, and tool to keep them updated
Browse files Browse the repository at this point in the history
Change-Id: I385171c415bf168c04c6c3a7a996bff88964af84
Reviewed-on: https://go-review.googlesource.com/52856
Reviewed-by: Andrew Bonventre <andybons@golang.org>
  • Loading branch information
bradfitz committed Aug 2, 2017
1 parent d29668b commit 73f88a6
Show file tree
Hide file tree
Showing 58 changed files with 483 additions and 0 deletions.
7 changes: 7 additions & 0 deletions auth/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions autocertcache/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions buildenv/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions buildlet/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/builder/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/buildlet/stage0/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/buildstats/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/cl/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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).
7 changes: 7 additions & 0 deletions cmd/coordinator/buildongce/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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


7 changes: 7 additions & 0 deletions cmd/coordinator/metrics/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/coordinator/spanlog/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/debugnewvm/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/docker2boot/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/fetchlogs/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/genbootstrap/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/gitlock/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/gitmirror/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/gomote/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/gopherbot/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/gopherstats/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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


7 changes: 7 additions & 0 deletions cmd/makemac/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/perfrun/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/pubsubhelper/pubsubtypes/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/racebuild/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/release/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/relnote/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/retrybuilds/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/rundockerbuildlet/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/scaleway/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions cmd/upload/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions dashboard/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions envutil/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions gerrit/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions internal/buildgo/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions internal/gophers/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions internal/httpdl/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions internal/loghash/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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).
7 changes: 7 additions & 0 deletions internal/lru/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions internal/singleflight/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions internal/sourcecache/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions internal/untar/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions kubernetes/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions kubernetes/api/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions kubernetes/gke/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions livelog/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions maintner/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions maintner/godata/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions maintner/gostats/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions maintner/maintnerd/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.
7 changes: 7 additions & 0 deletions maintner/maintpb/README.md
@@ -0,0 +1,7 @@
<!-- Auto-generated by x/build/update-readmes.go -->

[![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.

0 comments on commit 73f88a6

Please sign in to comment.