New: waitid man page does not document the 5th argument "struct rusage*"
https://bugzilla.kernel.org/show_bug.cgi?id=60744
Bug ID: 60744
Summary: waitid man page does not document the 5th argument
"struct rusage*"
Product: Documentation
Version: unspecified
Hardware: All
OS: Linux
Status: NEW
Severity: normal
Priority: P1
Component: man-pages
Assignee: documentation_man-pages-ztI5WcYan/[email protected]
Reporter: [email protected]
Regression: No
I just spent 5 hours debugging my program and trying to figure out why the kernel overwrote my stack. I had to read the source code to realize that the real syscall took an additional 5th argument.
Wrong signature:
int waitid(idtype_t idtype, id_t id, siginfo_t *infop, int options);
Correct signature:
int waitid(idtype_t idtype, id_t id, siginfo_t *infop, int options, struct rusage* rusage);
The kernel man pages should not assume that the user is using glibc, or at least give enough information for developers to write their own, correct wrappers.
Signature · 6 lines
You are receiving this mail because: You are watching the assignee of the bug. -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
[Bug 60744] waitid man page does not document the 5th argument "struct rusage*"
In reply to a message not in the archivehttps://bugzilla.kernel.org/show_bug.cgi?id=60744
Michael Kerrisk <[email protected]> changed:
What |Removed |Added
----------------------------------------------------------------------------
Status|NEW |RESOLVED
CC| |[email protected]
Resolution|--- |CODE_FIX--- Comment #1 from Michael Kerrisk <[email protected]> --- (In reply to Hannes Landeholm from comment #0)
Quoted 7 lines
I just spent 5 hours debugging my program and trying to figure out why the kernel overwrote my stack. I had to read the source code to realize that the real syscall took an additional 5th argument.
Wrong signature:
intwaitid(idtype_t idtype, id_t id, siginfo_t *infop, int options);
Quoted 7 lines
Correct signature:
intwaitid(idtype_t idtype, id_t id, siginfo_t *infop, int options, struct rusage* rusage);The kernel man pages should not assume that the user is using glibc, or at least give enough information for developers to write their own, correct wrappers.
To be precise, the page is documenting the POSIX waitid() interface (rather than glibc), but you are of course right that the page should make mention of the fifth argument. I've added some text on this.
Cheers,
Michael
Signature · 6 lines
You are receiving this mail because: You are watching the assignee of the bug. -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html