emo/procps
1
0
Fork 0
Code Issues Pull Requests Packages Releases Activity

docs: just a few changes to that new pids man document

Browse Source 
A patch to address the following man doc deficiencies:

. shorten NAME so there's no wrap in an 80x24 terminal
. typo wherein the 'item' parm should have been 'info'
. expand RETURN text for a potential NULL upon success

[ maybe, this might be my last tweak to this man doc ]

Signed-off-by: Jim Warner <james.warner@comcast.net>
This commit is contained in:
Jim Warner 2020-06-25 00:00:00 -05:00 committed by Craig Small
parent c02fc0b977
commit 3df74e7f3c
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/procps_pids.3
View File

@ -21,7 +21,7 @@
.\" .\"
.nh .nh
.SH NAME .SH NAME
procps_pids \- API to access task/thread information in the /proc filesystem procps_pids \- API to access process information in the /proc filesystem
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
@ -134,7 +134,7 @@ or \fBreset\fR.
Lastly, a \fBfatal_proc_unmounted\fR function may be called before Lastly, a \fBfatal_proc_unmounted\fR function may be called before
any other function to ensure that the /proc/ directory is mounted. any other function to ensure that the /proc/ directory is mounted.
As such, the \fIitem\fR parameter would be NULL and the As such, the \fIinfo\fR parameter would be NULL and the
\fIreturn_self\fR parameter zero. \fIreturn_self\fR parameter zero.
If, however, some items are desired for the issuing program (a If, however, some items are desired for the issuing program (a
\fIreturn_self\fR other than zero) then the \fBnew\fR call must precede \fIreturn_self\fR other than zero) then the \fBnew\fR call must precede
@ -154,6 +154,8 @@ An error will be indicated by a NULL return pointer
with the reason found in the formal errno value. with the reason found in the formal errno value.
Success is indicated by a pointer to the named structure. Success is indicated by a pointer to the named structure.
However, if one survives the \fBfatal_proc_unmounted\fR call,
NULL is always returned when \fIreturn_self\fR is zero.
.SH DEBUGGING .SH DEBUGGING
To aid in program development, there is a provision that can To aid in program development, there is a provision that can