golang / go

The Go programming language
https://go.dev
BSD 3-Clause "New" or "Revised" License
122.8k stars 17.51k forks source link

syscall: package is underdocumented #4318

Open gopherbot opened 11 years ago

gopherbot commented 11 years ago

by szopa@google.com:

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 commented 11 years ago

Comment 1:

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

Status changed to Accepted.

robpike commented 11 years ago

Comment 3:

Labels changed: removed go1.1maybe.

rsc commented 10 years ago

Comment 4:

Labels changed: added repo-main.

rsc commented 10 years ago

Comment 5:

Adding Release=None to all Priority=Someday bugs.

Labels changed: added release-none.

gopherbot commented 4 years ago

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