procps/doc
Jim Warner eadb9db58f docs: update 'first cut' procps.3 with revised version
This represents the 'second cut' at providing a shared
man page that supports more than one newlib interface.

In this approach, the following assumptions were made:

1) It is the kernel folks' job to document /proc files
not to mention fields within those files. And since we
don't yet know what some of those fields represent, we
shouldn't attempt to document any of those we do know.

2) Our header files serve as an essential reference in
successful exploitation of the new library interfaces.

3) The description represents functions as they appear
in the header itself making them immediately familiar.

4) Some inconsistencies among the interfaces have been
handled more visually rather than in a narrative form.

5) Armed with our header file users can easily see the
self-documenting enumerators & structures. There isn't
a need to explain them yet again in this man document.

6) Contrary to man guidelines, we shouldn't list error
codes. Simple generic guidance serves everyone better.

Reference(s):
. 05/19/20, procps.3 man page introduced
commit fc69028d37

Signed-off-by: Jim Warner <james.warner@comcast.net>
2020-06-23 19:09:05 +10:00
..
libproc.3 documentation: Update pids manual pages 2017-01-05 09:44:04 +11:00
procps_linux_version.3 misc: eliminated every instance of trailing whitespace 2016-07-09 12:48:28 +10:00
procps_ns_get_id.3 docs: Add namespace man pages 2020-05-18 21:42:49 +10:00
procps_ns_get_name.3 docs: Add namespace man pages 2020-05-18 21:42:49 +10:00
procps_ns_read_pid.3 docs: Add namespace man pages 2020-05-18 21:42:49 +10:00
procps_pids_new.3 documentation: Update pids manual pages 2017-01-05 09:44:04 +11:00
procps_pids_reap.3 documentation: Update pids manual pages 2017-01-05 09:44:04 +11:00
procps_pids_ref.3 documentation: Update pids manual pages 2017-01-05 09:44:04 +11:00
procps_pids_reset.3 documentation: Update pids manual pages 2017-01-05 09:44:04 +11:00
procps_pids_select.3 documentation: Update pids manual pages 2017-01-05 09:44:04 +11:00
procps_pids_sort.3 documentation: Update pids manual pages 2017-01-05 09:44:04 +11:00
procps_pids_unref.3 documentation: Update pids manual pages 2017-01-05 09:44:04 +11:00
procps_uptime_sprint_short.3 docs: Update the uptime man pages 2020-05-18 21:10:03 +10:00
procps_uptime_sprint.3 docs: Update the uptime man pages 2020-05-18 21:10:03 +10:00
procps_uptime.3 docs: Update the uptime man pages 2020-05-18 21:10:03 +10:00
procps.3 docs: update 'first cut' procps.3 with revised version 2020-06-23 19:09:05 +10:00