Document the PID argument in waitpid #654
Conversation
|
This is already being worked on in #651 and I'd prefer to avoid conflicting PRs here. Can you add comments there if that PR doesn't include documentation that you want to see for |
| @@ -215,6 +215,22 @@ fn decode(pid : Pid, status: i32) -> WaitStatus { | |||
| } | |||
| } | |||
|
|
|||
| /// Counterpart of the POSIX `waitpid` function | |||
There was a problem hiding this comment.
This should actually describe what waitpid does with a brief summary line at the top and maybe an extended summary below it (with a blank comment line in between). Just saying it is a wrapper around waitpid isn't very helpful.
Additionally can you link to the man page in the extended description here.
| @@ -215,6 +215,22 @@ fn decode(pid : Pid, status: i32) -> WaitStatus { | |||
| } | |||
| } | |||
|
|
|||
| /// Counterpart of the POSIX `waitpid` function | |||
| /// It's best to use `nix::unistd::Pid` for passing the PID to this function | |||
There was a problem hiding this comment.
Isn't this specified by the argument type?
|
Let's go ahead and move this forward since #651 looks stalled. |
|
@marmistrz I wanted to ping you on this. Would you be interested in updating this PR so we can get it merged? |
|
As in #666, when I have more time. |
|
@marmistrz Any idea when you'd be able to wrap this up? I'd like to either merge this or close this issue in the near future. |
|
@marmistrz looks like this fell off of your radar. Any interest in finishing it? |
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 <[email protected]> * Michael Aaron Murphy <[email protected]> Closes nix-rust#654 and nix-rust#651
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 <[email protected]> * Michael Aaron Murphy <[email protected]> Closes nix-rust#654 and nix-rust#651
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 <[email protected]> * Michael Aaron Murphy <[email protected]> Closes nix-rust#654 and nix-rust#651
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 <[email protected]> * Michael Aaron Murphy <[email protected]> Closes nix-rust#654 and nix-rust#651
No description provided.