Page MenuHomeFreeBSD

bhyve(8): Fix consistency and terms in manpage
ClosedPublic

Authored by michaelo on Sun, Dec 21, 4:46 PM.
Tags
None
Referenced Files
F140564195: D54332.diff
Thu, Dec 25, 8:11 AM
Unknown Object (File)
Wed, Dec 24, 10:01 PM
Unknown Object (File)
Wed, Dec 24, 4:41 PM
Unknown Object (File)
Mon, Dec 22, 3:56 PM
Unknown Object (File)
Mon, Dec 22, 6:52 AM
Unknown Object (File)
Mon, Dec 22, 4:18 AM

Details

Summary

Correct inconsistent spelling of terms and duplication.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 69437
Build 66320: arc lint + arc unit

Event Timeline

markj added inline comments.
usr.sbin/bhyve/bhyve.8
709–710
1046–1048

Can we fix these sentences while here?

A value of 1 indicates that the device is a solid state disk, i.e., non-rotational.
The default value is 0.
usr.sbin/bhyve/bhyve.8
171

For true consistency we actually need to standardize it the other way, the interface has been externally called fw_cfg since even before we got it, right?

https://www.qemu.org/docs/master/specs/fw_cfg.html

Thanks michaelo!

usr.sbin/bhyve/bhyve.8
712

In the roff language, new sentences start on newlines. You can check the linter with mandoc -Tlint /here/is/the/manual.

jhb added inline comments.
usr.sbin/bhyve/bhyve.8
680
711

That said, I would suggest a more active voice here, for this sentence, something like:

Only one active connection is allowed at any time.
The TCP server will immediately close new connections while an existing connection is active.
1024

This is the formatting consistently used in the NVMe 1.4b specification.

1180

Using this syntax is fine, but I don't think it is ambiguous to use plain GB here and elsewhere. Memory sizing is always power-of-2, so memory/RAM sizes and address space sizes (e.g. the 64K window for VGA) are always power-of-2. (This is different from some other places like disk sizes where it is indeed ambiguous.)

In particular, the syntax accepted for the command line doesn't accept the i, only GB or G (see expand_number(3)).

michaelo marked 6 inline comments as done.

Add updates

michaelo marked an inline comment as not done.Mon, Dec 22, 4:45 PM

Addressed issues.

usr.sbin/bhyve/bhyve.8
1180

I didn't change any or the options, put only free form prose.

This revision is now accepted and ready to land.Tue, Dec 23, 4:15 PM