Page MenuHomeFreeBSD

bhyve.8: Update and rearrange to improve readability
ClosedPublic

Authored by jrm on Apr 26 2024, 6:43 PM.
Tags
None
Referenced Files
F101981977: D44977.diff
Wed, Nov 6, 3:37 AM
Unknown Object (File)
Sun, Oct 20, 1:23 PM
Unknown Object (File)
Sep 25 2024, 11:00 AM
Unknown Object (File)
Sep 25 2024, 3:15 AM
Unknown Object (File)
Sep 24 2024, 5:37 PM
Unknown Object (File)
Sep 23 2024, 11:33 PM
Unknown Object (File)
Sep 23 2024, 9:50 AM
Unknown Object (File)
Sep 22 2024, 11:22 PM
Subscribers

Details

Reviewers
freebsd_ny-central.org
Group Reviewers
bhyve
Summary

bhyve's man page is a very long block of text that has grown to
proportions that make it hard to read. In particular, the level of
nesting of various content means man can no longer render the text in a
user-friendly way.

To remedy this:

  • move the -s argument documentation into a separate section and reformat the various arguments so they are consistent
  • add documentation on how to use the -o config.dump feature
  • make the listing of the various arguments more consistent
  • consolidated duplicate listing of TPM backends
  • add an example for the config.dump feature
  • fix various formatting inconsistencies.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 57401
Build 54289: arc lint + arc unit

Event Timeline

jrm requested review of this revision.Apr 26 2024, 6:43 PM
jrm retitled this revision from bhyve.8: Update an rearrange to improve readability to bhyve.8: Update and rearrange to improve readability.Apr 26 2024, 6:44 PM

Chris, rather than overwrite your review, I rebased your work on top of the latest of the main branch. The commit message is based on your summary in D43940. If everything looks good to you, I'll commit.

Looks good to me! Thanks for helping with the rebase. Need to keep in mind to keep those patches up-to-date in the future.

This revision is now accepted and ready to land.Apr 27 2024, 1:11 PM