aboutsummaryrefslogtreecommitdiff
path: root/api/README
diff options
context:
space:
mode:
authorBrad Fitzpatrick <bradfitz@golang.org>2012-05-22 18:41:20 -0700
committerBrad Fitzpatrick <bradfitz@golang.org>2012-05-22 18:41:20 -0700
commit71c1a7b77700ea8e549368c8606d74d7a7b5104f (patch)
treefa6ff20008539c733e4b1d11aaf7faa2ddf53014 /api/README
parent33a89b5fdad1917e292b7a8aea5f164c1460177d (diff)
downloadgo-71c1a7b77700ea8e549368c8606d74d7a7b5104f.tar.gz
go-71c1a7b77700ea8e549368c8606d74d7a7b5104f.zip
cmd/api: add api/next.txt
This quiets all.bash noise for upcoming features we know about. The all.bash warnings will now only print for things not in next.txt (or in next.txt but not in the API). Once an API is frozen, we rename next.txt to a new frozen file (like go1.txt) Fixes #3651 R=golang-dev, r CC=golang-dev https://golang.org/cl/6218069
Diffstat (limited to 'api/README')
-rw-r--r--api/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/api/README b/api/README
new file mode 100644
index 0000000000..6adc55454c
--- /dev/null
+++ b/api/README
@@ -0,0 +1,11 @@
+Files in this directory are data for Go's API checker ("go tool api", in src/cmd/api).
+
+Each file is a list of of API features, one per line.
+
+go1.txt (and similarly named files) are frozen once a version has been
+shipped. Each file adds new lines but does not remove any.
+
+next.txt is the only file intended to be mutated. It's a list of
+features that may be added to the next version. It only affects
+warning output from the go api tool.
+