Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

syscall: document that documentation is platform specific #4051

Closed
gopherbot opened this issue Sep 6, 2012 · 7 comments
Closed

syscall: document that documentation is platform specific #4051

gopherbot opened this issue Sep 6, 2012 · 7 comments

Comments

@gopherbot
Copy link

@gopherbot gopherbot commented Sep 6, 2012

by efairlight:

The syscall package is highly platform specific and the documentation seems to be
generated only for the platform the generator is running on (amd64-linux in the case of
http://tip.golang.org/pkg/syscall/ apparently). This leads to a lack of mention for any
other platform's functions, such as Exchangedata on Darwin, which is however available
on that platform.

Furthermore the documentation doesn't describe what's available on which platform, which
would be highly useful.
@gopherbot
Copy link
Author

@gopherbot gopherbot commented Sep 9, 2012

Comment 1 by lost.goblin:

AFAIK use of the syscall package is at least somewhat discouraged (among other things
code using it is inherently unportable), and I think in part the lack of documentation
is to discourage users.
Perhaps what would help is to document this situation more clearly, and explain under
what circumstances is recommended to use or not use the syscall package.
@rsc
Copy link
Contributor

@rsc rsc commented Sep 10, 2012

Comment 2:

We should at least note in the doc comment that things vary by system
and that godoc only shows the docs for the system it is running on.
@rsc
Copy link
Contributor

@rsc rsc commented Sep 12, 2012

Comment 3:

Labels changed: added priority-later, removed priority-triage.

Status changed to Accepted.

@rsc
Copy link
Contributor

@rsc rsc commented Sep 12, 2012

Comment 4:

Labels changed: added go1.1.

@rsc
Copy link
Contributor

@rsc rsc commented Dec 10, 2012

Comment 5:

Labels changed: added size-s.

@rsc
Copy link
Contributor

@rsc rsc commented Dec 10, 2012

Comment 6:

Labels changed: added suggested.

@minux
Copy link
Member

@minux minux commented Dec 17, 2012

Comment 7:

This issue was closed by revision 39835b4.

Status changed to Fixed.

@rsc rsc added this to the Go1.1 milestone Apr 14, 2015
@rsc rsc removed the go1.1 label Apr 14, 2015
@golang golang locked and limited conversation to collaborators Jun 24, 2016
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.