Skip to content

syscall: package is underdocumented #4318

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

Closed
gopherbot opened this issue Oct 31, 2012 · 6 comments
Closed

syscall: package is underdocumented #4318

gopherbot opened this issue Oct 31, 2012 · 6 comments
Labels
Documentation Issues describing a change to documentation. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone

Comments

@gopherbot
Copy link
Contributor

by [email protected]:

The standard library syscall package is underdocumented. I was trying to figure how to
write my own utimensat (unimplemented) and I was having a very hard time. What is more,
reading the source of the package doesn't really help, as its code is supposed to be
going through mksyscall.

What I would like to see:

1. An example of writing an unimplemented syscall.

2. How to pass arguments to syscalls (eg. strings should be pointers to nul terminated
byte sequences.

3. Information how to get the right uintptr (reflect or unsafe, when to use each of
them).

4. Documentation any types introduced.

5. A little bit of background information about syscalls would be nice, but that's not
strictly necessary.
@robpike
Copy link
Contributor

robpike commented Oct 31, 2012

Comment 1:

Labels changed: added priority-someday, go1.1maybe, documentation, removed priority-triage, go1.1.

Status changed to Accepted.

@robpike
Copy link
Contributor

robpike commented Mar 7, 2013

Comment 3:

Labels changed: removed go1.1maybe.

@rsc
Copy link
Contributor

rsc commented Dec 4, 2013

Comment 4:

Labels changed: added repo-main.

@rsc
Copy link
Contributor

rsc commented Mar 3, 2014

Comment 5:

Adding Release=None to all Priority=Someday bugs.

Labels changed: added release-none.

@gopherbot
Copy link
Contributor Author

Change https://golang.org/cl/242999 mentions this issue: syscall: document Sysinfo_t

@seankhliao seankhliao added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Jul 13, 2024
@seankhliao
Copy link
Member

Further work should probably be in x/sys/unix

@seankhliao seankhliao closed this as not planned Won't fix, can't repro, duplicate, stale Mar 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues describing a change to documentation. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Projects
None yet
Development

No branches or pull requests

4 participants