doc: Mention fatal_proc_unmounted limitations

Discovered this while trying to port programs that use the deleted
libprocps function look_up_our_self() which can be found with the
fatal_proc_unmounted() function.

While procps_pids_new() will allow you to specify any items you
care to think of, a subsequent call to fatal_proc_unmounted()
will only fill in the values found in /proc/self/stat.

Added a caveat to the procps_pids manpage pointing out this
limitation.

References:
 https://salsa.debian.org/xorg-team/app/apitrace/-/blob/debian-unstable/lib/os/os_memory.hpp#L44
 https://gitlab.com/-/snippets/2377884

Signed-off-by: Craig Small <csmall@dropbear.xyz>
This commit is contained in:
Craig Small 2022-07-27 21:12:10 +10:00
parent 80e2a7a682
commit 7d44c94317

View File

@ -152,6 +152,10 @@ As such, the \fIinfo\fR parameter would be NULL and the
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
it to identify the \fIitems\fR and obtain the required \fIinfo\fR pointer. it to identify the \fIitems\fR and obtain the required \fIinfo\fR pointer.
\fBfatal_proc_unmounted\fR function used in this way will only return a
subset of values found in /proc/self/stat file. Check the \fIpids_item\fR
enum in <procps/pids.h> for items with origin of \fIstat:\fR to see what
are the available values.
.SH RETURN VALUE .SH RETURN VALUE
.SS Functions Returning an `int' .SS Functions Returning an `int'