man9: Add a manual page for kstack_contains(9).
Details
Details
Diff Detail
Diff Detail
- Repository
- rG FreeBSD src repository
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 51308 Build 48199: arc lint + arc unit
Event Timeline
Comment Actions
LGTM, with one more nit that can be fixed before commit.
One thing I am trying to be more considerate of when it comes to section 9 pages is "how can this page be discovered?" In other words, is it cross-referenced from another man page or is it referenced anywhere in the source code? I do not think there are any obvious candidates which should reference kstack_contains(9) in their SEE ALSO, but pointing to the man page at the kstack_contains() definitions might help the reader learn that the page exists at all. Just something to consider, I am not asking you to do anything specific here.
| share/man/man9/kstack_contains.9 | ||
|---|---|---|
| 54 | Sorry, one more that I missed. | |
Comment Actions
One thing I am trying to be more considerate of when it comes to section 9
pages is "how can this page be discovered?" In other words, is it cross-referenced
from another man page or is it referenced anywhere in the source code? I do not
think there are any obvious candidates which should reference kstack_contains(9)
in their SEE ALSO, but pointing to the man page at the kstack_contains() definitions
might help the reader learn that the page exists at all. Just something to consider,
I am not asking you to do anything specific here.
My guess is that readers are likely to run man 9 kstack_contains when they
come across it in the source code, so it would be implicitly discoverable.
Should we re-purpose intro(9) to mention the major groups of section 9 APIs?
Comment Actions
This is actually exactly my plan, and I have a rewrite of this page in-progress. I definitely want to have that completed for the 14.0 release, so you can expect to see a review in the next couple of weeks.