summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* misc: Move Documentation to docCraig Small2022-08-297-0/+545
| | | | Signed-off-by: Craig Small <csmall@dropbear.xyz>
* build-sys: Rearrange the manual pagesCraig Small2022-08-293-576/+0
| | | | | | | | | | All man pages are found in ./man man-po -> po-man References: https://www.freelists.org/post/procps/Next-for-newlib,3 Signed-off-by: Craig Small <csmall@dropbear.xyz>
* doc: revert mention of limits for fatal_proc_unmountedJim Warner2022-08-011-4/+0
| | | | | | | | | | | | With the next commit the fatal_proc_unmounted function will be refactored to behave as it always should have. So, a need for the user 'stat' caution will disappear. Reference(s): . original man page change commit 7d44c94317941c1cd3d41325a0128010fe5d1331 Signed-off-by: Jim Warner <james.warner@comcast.net>
* doc: Mention fatal_proc_unmounted limitationsCraig Small2022-07-271-0/+4
| | | | | | | | | | | | | | | | | | | 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>
* doc: make the library API pages a little more readableJim Warner2022-07-273-64/+63
| | | | | | | | | | | | | | Use of the the '.B' and '.BI' man documentation macros had rendered the three library API pages less readable than they could be. In addition, sometimes the pointer indicator and an identifier were separated by a space. So, this commit will trade those macros for some '.RI' and '.RB' macros plus treat the pointers consistently. [ plus we no longer italicize sort 'stacks' brackets ] Signed-off-by: Jim Warner <james.warner@comcast.net>
* doc: bring the namespaces up to date with linux kernelJim Warner2022-05-091-0/+2
| | | | Signed-off-by: Jim Warner <james.warner@comcast.net>
* doc: minor tweaks affecting three newlib man documentsJim Warner2022-02-273-7/+7
| | | | | | | | | | . add the proper function names to the procps_pids man page when discussing the 'LIBPROC_HIDE_KERNEL' feature under recently added 'ENVIRONMENT VARIABLE(S)' section . ensure the 'SEE ALSO' references are comma delimited Signed-off-by: Jim Warner <james.warner@comcast.net>
* misc: fixed several inconsistencies in email addressesJim Warner2022-01-083-3/+3
| | | | | | | | [ you wouldn't believe how many back-and-forths were ] [ involved in Craig convincing me there were several ] [ inconsistencies. i am so dense sometimes (often?). ] Signed-off-by: Jim Warner <james.warner@comcast.net>
* doc: updated 3 man pages for 'LIBPROC_HIDE_KERNEL' varJim Warner2022-01-071-0/+8
| | | | | | | | | | | | | | This patch was prompted by Björn Fischer's merge #147 request referenced below. And since the library change may impact all users, multiple man pages were updated. [ and thanks to Björn for initiating this extension ] Reference(s): https://gitlab.com/procps-ng/procps/-/merge_requests/147 Prototyped-by: Björn Fischer <bf@CeBiTec.Uni-Bielefeld.DE> Signed-off-by: Jim Warner <james.warner@comcast.net>
* misc: amend the man page & source file copyright datesJim Warner2022-01-073-6/+6
| | | | | | | This just updates the copyright dates in the documents where I was already represented. Others are unchanged. Signed-off-by: Jim Warner <james.warner@comcast.net>
* doc: added the new valgrind 'warning-suppression' fileJim Warner2021-10-181-4/+15
| | | | Signed-off-by: Jim Warner <james.warner@comcast.net>
* docs: fix a couple of spelling errors in new man pagesJim Warner2021-04-062-4/+4
| | | | Signed-off-by: Jim Warner <james.warner@comcast.net>
* docs: tweak two man pages due to renaming of libproc-2Jim Warner2021-02-232-3/+3
| | | | | | | Reference(s): commit 9aa09d8862c00a8dc85910d0365332c8c99b59ce Signed-off-by: Jim Warner <james.warner@comcast.net>
* library: Rename to libproc-2Craig Small2021-02-201-1/+1
| | | | | | | | | | | | | | | | | | | | | | What to call the new library? Keep using libprocps wouldn't do, its a very different library from the programs' point of view. It would also mean we could have some clashes around the packages (two package names, same library name). The ancient procps used libproc or libproc-a.b.c where a.b.c was the package version. Kept the revision numbers down (it was always 0.0.0) but the name of the library changed. So if we use libproc-2 is there a clash with an ancient procps? procps v 2.0.0 was around in 1999 so it was 22 years ago, also the name of the library would have been libproc-2.0.0.so not libproc-2.so so we're fine with that. libproc-2 seems to fit, our second major re-work of the procps library. Signed-off-by: Craig Small <csmall@dropbear.xyz>
* docs: adjust revision date for our three new man pagesJim Warner2021-02-183-3/+3
| | | | Signed-off-by: Jim Warner <james.warner@comcast.net>
* docs: expand 2 man pages 'Usage' to include VAL macrosJim Warner2021-02-182-22/+54
| | | | | | | | | | | | | | | | Maybe, the biggest obstacle to successfully exploiting this new library is after those `stacks' are returned. Unless a user requests all available `items', there is always a need to translate an actual enumerator into a relative position within returned stack(s) of results. So, this patch attempts to bridge that gap by adding a brief explanation to the existing discussion in Usage. [ along the way, 'Usage' & 'Caveats' were refactored ] Signed-off-by: Jim Warner <james.warner@comcast.net>
* docs: bring 2 man pages into agreement regarding sortsJim Warner2021-02-092-5/+4
| | | | Signed-off-by: Jim Warner <james.warner@comcast.net>
* docs: adapt procps_misc.3 for new 'misc.h' header fileJim Warner2021-01-211-134/+84
| | | | | | | | | | | | This commit adapts our man page for a new consolidated 'misc.h' header file. Along the way, some descriptions were shortened, others lengthened and whitespace added in an effort to (hopefully) improve readability a bit. [ the #include subdirectory was also corrected while ] [ rearranging & grouping functions into 3 categories ] Signed-off-by: Jim Warner <james.warner@comcast.net>
* docs: update copyright, revision plus name for 2 pagesJim Warner2021-01-212-4/+4
| | | | Signed-off-by: Jim Warner <james.warner@comcast.net>
* docs: Merge procps_uptime_* into procps_misc.3Craig Small2020-12-214-79/+40
|
* doc: fix typo in procps_miscCraig Small2020-12-211-1/+1
|
* docs: Merge procps_ns_* into miscCraig Small2020-12-214-79/+33
|
* docs: Merge procps_linux_version into miscCraig Small2020-12-212-93/+59
|
* docs: Add procps_misc.3 manpageCraig Small2020-10-241-0/+82
| | | | The last (I think) of the newlib man pages for the new API.
* docs: just a few changes to that new pids man documentJim Warner2020-06-291-2/+4
| | | | | | | | | | | | 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>
* docs: tweak both of those newly created man docs a tadJim Warner2020-06-252-3/+10
| | | | | | | | | | | 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: replace 'procps_pids' stuff with revised versionJim Warner2020-06-239-697/+180
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The original approach contained a fatal flaw. In order to use those man pages, users would have been required to already know how to use the library. Or alternately one could randomly search each of them while trying to ascertain which function call satisfies their need and what exactly was the proper compliment/order required. So, this revised approach tries to simplify things and document only what is not apparent in the header file. Along the way, the following assumptions were germane. 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 file serves as an essential reference in successful exploitation of this new library interface. 3) The description represents functions as they appear in the header itself making them immediately familiar. 4) 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. 5) Contrary to man guidelines, we shouldn't list error codes. Simple generic guidance serves everyone better. The following references represent a history for those man documents this new version is intended to replace. Reference(s): . 04/18/16, create libproc.3 + procps_pids_new.3 commit 4217eddf474debe55a7651757ccce1e86aeb04a5 . 04/19/16, create procps_pids_read_open.3 commit d48c54f6793d5faf44e420df43a75e04372d5945 . 01/05/17, create many procps_pids_... docs commit 2598e9f2ce39c93ebf55f664454d3bea919ed4e0 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.
* docs: Add namespace man pagesCraig Small2020-05-183-0/+78
|
* docs: Update the uptime man pagesCraig Small2020-05-183-69/+28
| | | | | Three functions in the same manpage but use the so commands to refer to the main man page.
* documentation: Update pids manual pagesCraig Small2017-01-059-216/+568
| | | | | | Updated the full suite of manual pages for the procps_pids_* functions. The only one missing is procps_pids_get which may not be required.
* misc: eliminated every instance of trailing whitespaceJim Warner2016-07-091-2/+2
| | | | | | [ alas, there were only two instances (1 file) found ] Signed-off-by: Jim Warner <james.warner@comcast.net>
* library: protect against large version numbers.Craig Small2016-05-011-1/+10
| | | | | | | | Linux release numbers are x.y.z we assumed but never protected against x> 0x7fff and y,z > 0xff before. Linux release in 1991, 1 major release per 6 years so we're fine until 7452, unless they do way too many minor rels (max being 39)
* library: procps_uptime() return value is a statusCraig Small2016-05-011-2/+2
| | | | | | | | | | | | | | | | | | | | | | procps_uptime, previously just plain uptime() used to put the uptime (as a double) in the first argument and return uptime (as an int). It meant if you ran myuptime2 = procps_uptime(&myuptime1, NULL); You might get different results for myuptime1 and myuptime2 because they are different types. Most library calls use the return value to return the status, procps_uptime was in the middle. Until now. This function will return 0 on success. If you want (for whatever reason) uptime as an int then cast it. All of the procps binaries didn't use the return value for uptime except ps which set a variable to it but never used it anywhere.
* docs: Additional flags in man pagesCraig Small2016-04-192-279/+229
| | | | More PIDS defintions
* docs: Start documenting the pids APICraig Small2016-04-182-0/+395
| | | | | Started with procps_pids_new() and documenting this function as well as the enum used in this function.
* library: document and tests for uptime functionsCraig Small2016-04-163-0/+120
| | | | | man pages for the three procps_uptime* functions and simple test scripts for same functions.
* docs: Cleanup procps_linux_version pageCraig Small2016-04-161-15/+36
| | | | | | Getting the manual page for procps_linux_version(3) fixed up so it follows the man-pages(7) and other standards. Added lgpl license to file, so its the same as the code.
* libprocps version test and documentationCraig Small2016-04-141-0/+63
test binary and man page for the version part of libprocps. It's a simple start, but it's a start!
View Lorry Controller Status