libutil: Document struct kinfo_proc in kinfo_getproc(3) #1884
+255
−5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you for taking the time to contribute to FreeBSD! Please review CONTRIBUTING.md, then update and push your branch again. |
Add comprehensive documentation for struct kinfo_proc: - Add complete C-style struct definition with types and inline comments showing all user-accessible fields - Document key fields including process identifiers, credentials, memory statistics, runtime information, and flags - Clarify process flag fields (ki_flag, ki_kiflag, ki_flag2) with examples and header file references - Add complete, compilable example program demonstrating memory usage reporting - Add CAVEATS section documenting ABI stability, machine-dependent fields, and portability considerations across BSD systems - Clarify description of function behavior and memory allocation - Add cross-references to related manual pages The struct definition excludes internal kernel pointers and uses a single ellipsis for additional fields, following the style of other system structure documentation. Signed-off-by: Vsevolod Stakhov <[email protected]>
Enhance the kinfo_getproc(3) manual page example: - Make example work without arguments by defaulting to current process when no PID is specified - Make memory output consistent by displaying all values in KB instead of mixing bytes and KB - Add compilation instructions showing that -lutil is required Improve struct documentation: - Add comment about ki_structsize and KINFO_PROC_SIZE macro for determining actual structure size - Direct readers to <sys/user.h> for full structure definition - Move ellipsis inside comment to make struct syntactically valid C Add cross-reference to kinfo_getproc(3) in libprocstat(3) manual page since it provides comprehensive documentation for struct kinfo_proc. Signed-off-by: Vsevolod Stakhov <[email protected]>
concussious
reviewed
Nov 5, 2025
Contributor
concussious
left a comment
concussious
left a comment
There was a problem hiding this comment.
This is not a complete review as I am not familiar with the subject matter.
Co-authored-by: Alexander Ziaee <[email protected]>
Co-authored-by: Alexander Ziaee <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document
struct kinfo_procwith complete field descriptions, add CAVEATS about ABI stability and machine-dependent fields, provide an example with build instructions, and addlibprocstat(3)cross-reference.