Details

Reviewers

None

Group Reviewers

manpages

Commits

rS359076: MFC of r355574, r358095, and r358395:
rS355574: Add ACPI battery subsystem man page.

Summary

ACPI battery subsystem was lack of document.
So I write man page for it.

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 27830
Build 26009: arc lint + arc unit

Event Timeline

takawata created this revision.Nov 26 2019, 8:42 AM

Herald added a reviewer: manpages. · View Herald TranscriptNov 26 2019, 8:42 AM

Herald added a subscriber: imp. · View Herald Transcript

Harbormaster completed remote builds in B27773: Diff 64880.Nov 26 2019, 8:42 AM

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
68	s/Retruns/Returns/

Fix errors: typo and mandoc -Tlint.

Harbormaster completed remote builds in B27776: Diff 64884.Nov 26 2019, 10:14 AM

Forget to change description from acpi_thermal.4, which was based.

Harbormaster completed remote builds in B27777: Diff 64885.Nov 26 2019, 10:17 AM

danfe added a subscriber: danfe.Nov 27 2019, 1:48 PM

danfe added inline comments.

share/man/man4/acpi_battery.4
43	You should get confirmation from the native speaker, but it looks like the is missing before one and AML.
98	Ditto before the ACPI.
110	Apparently missing word between units (used?) by the battery...
121	Is a really needed here before capacity and rate (below)?
140	by, not in?
145	Maybe just notification is sent to the system (without leading a)?
149	Shouldn't it be spelled as `.Va low` and `.Va warning` so they stand out? Ditto below for warning and full.
159	Hmm, in string does not look grammatically correct to me (here and below).
168	... given by the ACPI `_BST` ..., perhaps?
224	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.
241	Shouldn't the the be moved to the right? That is, Note that notifications are supported only by the CMB

Thank you for your comment. I've updated it following your advice.

Harbormaster completed remote builds in B27830: Diff 65002.Nov 28 2019, 10:43 AM

I found two instances of superfluous spaces. I think once they are fixed, we can go ahead and commit the man page.

share/man/man4/acpi_battery.4
120	There is an extra space here between "that" and "capacity".
121	and here is another extra space.

Thanks. corrected.

Harbormaster completed remote builds in B27906: Diff 65157.Dec 3 2019, 10:28 AM

Looks good, thanks for writing this! Some suggestions inline. Please also bump .Dd before you commit this.

share/man/man4/acpi_battery.4
43	"The former is accessed by AML"
48	"an" or "the" SMBus interface perhaps?
49	"both in" can be removed
53	as -> as the
57	for -> for the
68	number of the -> number of
125	The battery's
137	Secondary
144	Remove "to"
152	Missing space between warning and .
161	These two lines should be joined, e.g. ".Va full ."
193	depends
240	Either "via the devd(8) interface" or " via devd(8)" (with the .Xr markup that's already there)