Documentation improvements #449
Conversation
Signed-off-by: Paul Osborne <paul.osborne@smartthings.com>
Signed-off-by: Paul Osborne <osbpau@gmail.com>
Signed-off-by: Paul Osborne <osbpau@gmail.com>
Signed-off-by: Paul Osborne <osbpau@gmail.com>
This is a logical companion to setpgid, so adding an implementation. Signed-off-by: Paul Osborne <osbpau@gmail.com>
Signed-off-by: Paul Osborne <osbpau@gmail.com>
Signed-off-by: Paul Osborne <osbpau@gmail.com>
Signed-off-by: Paul Osborne <osbpau@gmail.com>
Signed-off-by: Paul Osborne <osbpau@gmail.com>
| /// various system system/libc calls that might fail. Each | ||
| /// error has a corresponding errno (usually the one from the | ||
| /// underlying OS) to which it can be mapped in addition to | ||
| /// implementing other common traits. |
There was a problem hiding this comment.
should we doc InvalidPath or just punt on it in hopes we actually kill it soon?
There was a problem hiding this comment.
should we doc InvalidPath or just punt on it in hopes we actually kill it soon?
I think we can punt on it for now. I avoided since I thought it was likely to change.
| /// use nix::unistd::{fork, ForkResult}; | ||
| /// | ||
| /// match fork() { | ||
| /// Ok(ForkResult::Parent { child, .. }) => { |
There was a problem hiding this comment.
Basically, if other members were to ever be added in the future, things will keep working.
|
General thought: should we be linking just to Linux man pages at man7.org? |
Although the man7.org pages are part of the Linux manpages project, Kerrisk has done a pretty good job of putting in notes on portability. I think they are probably the single best source to link to if we are going to link to one source. Linking to others might be something that could be done eventually, but at least initially I am relatively happy just linking to man7 unless there are major differences that users need to be aware of. |
|
I'm going to infer an approval from @kamalmarhubi and go ahead and get this merged as I have even more in the pipeline. @homu r=kamalmarhubi |
|
📌 Commit fdf8ab6 has been approved by |
Documentation improvements This series of commits starts to fill in documentation that was not previously present for various calls, mostly in unistd for this pass. r? @kamalmarhubi
|
☀️ Test successful - status |
This series of commits starts to fill in documentation that was not previously present for various calls, mostly in unistd for this pass.
r? @kamalmarhubi