ACPI battery subsystem was lack of document.
So I write man page for it.
Details
- Reviewers
- None
- Group Reviewers
manpages - Commits
- rS359076: MFC of r355574, r358095, and r358395:
rS355574: Add ACPI battery subsystem man page.
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
Thank you for writing the man page!
I've found a typo. Can you run textproc/igor and "mandoc -Tlint" over the man page and see if they turn up any warnings?
share/man/man4/acpi_battery.4 | ||
---|---|---|
67 ↗ | (On Diff #64880) | s/Retruns/Returns/ |
share/man/man4/acpi_battery.4 | ||
---|---|---|
42 ↗ | (On Diff #64885) | You should get confirmation from the native speaker, but it looks like the is missing before one and AML. |
97 ↗ | (On Diff #64885) | Ditto before the ACPI. |
109 ↗ | (On Diff #64885) | Apparently missing word between units (used?) by the battery... |
120 ↗ | (On Diff #64885) | Is a really needed here before capacity and rate (below)? |
139 ↗ | (On Diff #64885) | by, not in? |
144 ↗ | (On Diff #64885) | Maybe just notification is sent to the system (without leading a)? |
148 ↗ | (On Diff #64885) | Shouldn't it be spelled as .Va low and .Va warning so they stand out? Ditto below for warning and full. |
158 ↗ | (On Diff #64885) | Hmm, in string does not look grammatically correct to me (here and below). |
167 ↗ | (On Diff #64885) | ... given by the ACPI _BST ..., perhaps? |
223 ↗ | (On Diff #64885) | life of battery sounds a bit weird, as if the battery would really die after it discharges. :-) Even battery life is better, if it's hard to avoid using file altogether. |
240 ↗ | (On Diff #64885) | Shouldn't the the be moved to the right? That is, Note that notifications are supported only by the CMB |
Looks good, thanks for writing this! Some suggestions inline. Please also bump .Dd before you commit this.
share/man/man4/acpi_battery.4 | ||
---|---|---|
124 ↗ | (On Diff #65157) | The battery's |
136 ↗ | (On Diff #65157) | Secondary |
143 ↗ | (On Diff #65157) | Remove "to" |
151 ↗ | (On Diff #65157) | Missing space between warning and . |
160 ↗ | (On Diff #65157) | These two lines should be joined, e.g. ".Va full ." |
192 ↗ | (On Diff #65157) | depends |
239 ↗ | (On Diff #65157) | Either "via the devd(8) interface" or " via devd(8)" (with the .Xr markup that's already there) |
42 ↗ | (On Diff #64885) | "The former is accessed by AML" |
47 ↗ | (On Diff #64885) | "an" or "the" SMBus interface perhaps? |
48 ↗ | (On Diff #64885) | "both in" can be removed |
52 ↗ | (On Diff #64885) | as -> as the |
56 ↗ | (On Diff #64885) | for -> for the |
67 ↗ | (On Diff #64885) | number of the -> number of |