Add a man-page that contains all of the stat utilities in the base system.
It can be quite handy instead of having to pipe apropos stat through less.
Also connect it to the build
Details
Details
igor stats.7
mandoc stats.7 | less
mandoc -Thtml ./stats.7
Diff Detail
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 30515 Build 28262: arc lint + arc unit
Event Timeline
| share/man/man7/stats.7 | ||
|---|---|---|
| 29 | "syndry" is probably a typo, right? | |
| 31 | Please replace FreeBSD with .Fx. | |
| 37 | Macros are not expanded in the argument to -width. btsockstat is probably what you want. | |
| 38 | We should probably just use Xr or at least Nm here instead of Cm. | |
| 39 | Bluetooth should probably be capitalized. | |
| 62 | Inconsistent use of a period at the end of the description. | |
| share/man/man7/stats.7 | ||
|---|---|---|
| 82 | Missing commas. | |
Comment Actions
Address typo, .Fx, macro usage, s/Cm/Xr/g, capitalization, inconsistent period, and wordsmithed a bit.
Comment Actions
I believe I've addressed the issues.
I'm going to go ahead and ask around for whether I missed any stat commands that haven't got a man-page.
If there are any, they will subsequently need to get one, of course. ;)
Comment Actions
Not sure if ministat belongs on the list. It is more for doing statistical analysis, it doesn't actually give you any stats/status about your system
Comment Actions
That's a good point - I'll remove it, and fix another thing pointed out by RhodiumToad on irc.
Comment Actions
Remove ministat, add stat, remove erroneous comma, wordsmithed the history section, and addressed issue to clarify that FreeBSD base contains more than just man-pages.
Comment Actions
Glad to have so many reviews :)
So, here's a question since vkarlsen on irc pointed out that hoststat and purgestat are also in base, but RhodiumToad pointed out that they're specifically for sendmail. Should they be added? I'm not familiar enough with them to write a man-page for them.
Comment Actions
Replace Xr with Nm as it, at least in less, bolds the commands making it easier to read.
| share/man/man7/stats.7 | ||
|---|---|---|
| 31 | .Fx should be on a new line like so: The | |
Comment Actions
I must've missed .Fx on a separate line the first time around.
Thank you for catching it again :)
Comment Actions
In that case I'd at least add all the Xr to see also.
We can do cross-references to stats(7) from other manpages in subsequent commits.
Comment Actions
Cross-reference man-pages listed in this document
I don't really mind cross-referencing all other man-pages now, should I go ahead and do it?
Comment Actions
Comment about the BUGS section.
| share/man/man7/stats.7 | ||
|---|---|---|
| 123 | I don't think we should make any promises of features arriving in future releases in the BUGS section. We would have to do a follow-up commit to clean these up once these features have (or have not) landed. | |
Comment Actions
Remove BUGS section
I'm happy to not have bugs, even if it's an easy way to accomplish it. ;)
Comment Actions
Thank you very much :)
You're welcome to do s/man-page/manual\ page/ for the title. :)