summaryrefslogtreecommitdiff
path: root/doc/procps.3
Commit message (Collapse)AuthorAgeFilesLines
* docs: tweak both of those newly created man docs a tadJim Warner2020-06-251-0/+3
| | | | | | | | | | | An important fact was omitted in the DEBUGGING section for the two newest man documents. Users must utilize a macro in the header files before verification happens. So, this commit will sneak in such mention and in that way reduce future liability if the feature won't work. Signed-off-by: Jim Warner <james.warner@comcast.net>
* docs: update 'first cut' procps.3 with revised versionJim Warner2020-06-231-141/+135
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 fc69028d374ae933b55b05b0f1418ac6a3da87e2 Signed-off-by: Jim Warner <james.warner@comcast.net>
* doc: First cut at new combined API docCraig Small2020-05-191-0/+179
Instead of repeating the same thing for each info type, use one huge man page. Needs more work but lets see how it looks for now.