mirror of
https://github.com/golang/go
synced 2024-11-18 12:54:44 -07:00
syscall: document that documentation is platform specific
Fixes #4051 R=golang-dev, minux.ma, rsc CC=golang-dev https://golang.org/cl/6943063
This commit is contained in:
parent
ca4b868e9a
commit
39835b4aa0
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user