summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRob Pike <r@golang.org>2014-08-12 15:28:45 -0700
committerRob Pike <r@golang.org>2014-08-12 15:28:45 -0700
commit00ae8a464ae040ddf551bc2cd87466cf9bcd6760 (patch)
treee4036d7c2f8c72788b74cd6ad0beafbe764e950f /doc
parent9cd8a1f057d61185e88c474291caf229acf1921b (diff)
downloadgo-00ae8a464ae040ddf551bc2cd87466cf9bcd6760.tar.gz
syscall: freeze the package
Add a clause to the doc comment for the package and a paragraph in the compatibility document explaining the situation. LGTM=bradfitz, adg, rsc R=golang-codereviews, adg, bradfitz, minux, rsc CC=golang-codereviews https://codereview.appspot.com/129820043
Diffstat (limited to 'doc')
-rw-r--r--doc/go1compat.html14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/go1compat.html b/doc/go1compat.html
index d10b9af29..2c8d21484 100644
--- a/doc/go1compat.html
+++ b/doc/go1compat.html
@@ -152,6 +152,20 @@ will be tagged as appropriate to identify versions that are compatible
with the Go 1 point releases.
</p>
+<h2 id="operating_systems">Operating systems</h2>
+
+<p>
+It is impossible to guarantee long-term compatibility with operating
+system interfaces, which are changed by outside parties.
+The <a href="/pkg/syscall/"><code>syscall</code></a> package
+is therefore outside the purview of the guarantees made here.
+As of Go version 1.4, the <code>syscall</code> package is frozen.
+Any evolution of the system call interface must be supported elsewhere,
+such as in the <code>go.sys</code> subrepository.
+For details and background, see
+<a href="https://golang.org/s/go1.4-syscall">this document</a>.
+</p>
+
<h2 id="tools">Tools</h2>
<p>