From: Christopher Nielsen <m4dh4tt3r@gmail.com>
Date: Mon, 17 Dec 2012 14:50:00 +0000 (+0800)
Subject: syscall: document that documentation is platform specific
X-Git-Tag: go1.1rc2~1612
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=39835b4aa0e3e8dbf90849812c8657d85a3b1a44;p=gostls13.git

syscall: document that documentation is platform specific

Fixes #4051

R=golang-dev, minux.ma, rsc
CC=golang-dev
https://golang.org/cl/6943063
---

diff --git a/src/pkg/syscall/syscall.go b/src/pkg/syscall/syscall.go
index f97338c19c..f7473fd5aa 100644
--- a/src/pkg/syscall/syscall.go
+++ b/src/pkg/syscall/syscall.go
@@ -3,10 +3,15 @@
 // license that can be found in the LICENSE file.
 
 // Package syscall contains an interface to the low-level operating system
-// primitives.  The details vary depending on the underlying system.
-// Its primary use is inside other packages that provide a more portable
-// interface to the system, such as "os", "time" and "net".  Use those
-// packages rather than this one if you can.
+// primitives.  The details vary depending on the underlying system, and
+// by default, godoc will display the syscall documentation for the current
+// system.  If you want godoc to display syscall documentation for another
+// system, set $GOOS and $GOARCH to the desired system.  For example, if
+// you want to view documentation for freebsd/arm on linux/amd64, set $GOOS
+// to freebsd and $GOARCH to arm.
+// The primary use of syscall is inside other packages that provide a more
+// portable interface to the system, such as "os", "time" and "net".  Use
+// those packages rather than this one if you can.
 // For details of the functions and data types in this package consult
 // the manuals for the appropriate operating system.
 // These calls return err == nil to indicate success; otherwise