FAQ
Reviewers: golang-dev_googlegroups.com,

Message:
Hello golang-dev@googlegroups.com (cc: golang-dev@googlegroups.com),

I'd like you to review this change to
https://code.google.com/p/go


Description:
syscall: document that documentation is platform specific

Fixes issue 4051

Please review this at https://codereview.appspot.com/6943063/

Affected files:
M src/pkg/syscall/syscall.go


Index: src/pkg/syscall/syscall.go
===================================================================
--- a/src/pkg/syscall/syscall.go
+++ b/src/pkg/syscall/syscall.go
@@ -3,10 +3,11 @@
// 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
+// godoc will only display the syscall documentation for the system on
+// which it is running. 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.
// 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

Search Discussions

  • Minux Ma at Dec 15, 2012 at 6:02 pm
    https://codereview.appspot.com/6943063/diff/5001/src/pkg/syscall/syscall.go
    File src/pkg/syscall/syscall.go (right):

    https://codereview.appspot.com/6943063/diff/5001/src/pkg/syscall/syscall.go#newcode7
    src/pkg/syscall/syscall.go:7: // godoc will only display the syscall
    documentation for the system on
    this is actually incorrect.
    you can view docs for other OS/arch by explicitly setting $GOARCH and
    $GOOS. I suggest we add this as it is very useful to be able to see
    docs for other platforms without first install a cross compilation
    version of Go.

    https://codereview.appspot.com/6943063/

Related Discussions

Discussion Navigation
viewthread | post
Discussion Overview
groupgolang-dev @
categoriesgo
postedDec 15, '12 at 5:50p
activeDec 15, '12 at 6:02p
posts2
users2
websitegolang.org

2 users in discussion

Minux Ma: 1 post M4dh4tt3r: 1 post

People

Translate

site design / logo © 2021 Grokbase