Document the sys::wait module #1732
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vkkoskie
force-pushed
the
wait-documentation
branch
2 times, most recently
from
2ccb464 to
c1f1007
Compare
|
The Haiku failure is an issue with the rust stdlib. I'll work on a fix. |
asomers
requested changes
Jun 8, 2022
| /// and `PtraceSyscall`. Portable code should avoid exhaustively | ||
| /// matching on `WaitStatus`. | ||
| /// Note that there are two Linux-specific enum variants, | ||
| /// [`PtraceEvent`](WaitStatus) and [`PtraceSyscall`](WaitStatus). |
There was a problem hiding this comment.
Are these links correct or did you mean to link to the specific enum variants?
There was a problem hiding this comment.
Listing the variants breaks CI builds on the platforms where those variants don't exist. This was my solution after I couldn't figure out how to make cfg apply to the comment block instead of the enum below. Happy to make the change if you know how.
Noteworthy secondary changes included as a result of the primary documentation: * Additions to unistd::Pid to support waitpid calling conventions * Change the waitpid function signature (backward compatible) * Application of rustfmt to unistd.rs and sys::wait.rs Continued from work by * Marcin Mielniczuk <marmistrz.dev@gmail.com> * Michael Aaron Murphy <mmstickman@gmail.com> Closes nix-rust#654 and nix-rust#651
vkkoskie
force-pushed
the
wait-documentation
branch
from
0f3a833 to
d01d593
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Noteworthy secondary changes included as a result of the primary documentation:
Continued from work by
Closes #654 and #651