Page MenuHomeFreeBSD

Update for bhyve.8 man page
AbandonedPublic

Authored by freebsd_ny-central.org on Feb 16 2024, 6:00 PM.
Referenced Files
Unknown Object (File)
Thu, Jun 13, 6:26 PM
Unknown Object (File)
Wed, Jun 12, 11:51 PM
Unknown Object (File)
Wed, Jun 12, 11:51 PM
Unknown Object (File)
Wed, Jun 12, 11:50 PM
Unknown Object (File)
Wed, Jun 5, 4:47 PM
Unknown Object (File)
Mon, Jun 3, 5:55 PM
Unknown Object (File)
Sun, May 26, 4:06 AM
Unknown Object (File)
Thu, May 23, 6:19 AM

Details

Summary

The current version of bhyve's man page is a very long block of text that has grown to proportions that are hard to read - particularly, because the nesting of various content has reached a depth that man no longer can render the text in a user friendly manner.

I used this opportunity to apply the following additional changes:

  • I suggest moving the -s argument documentation into a separate section and reformatting the various arguments so they are consistent.
  • added some documentation on how to use the -o config.dump feature
  • made the listing of the various arguments more consistent
  • consolidated duplicate listing of TPM backends
  • updated the document date
  • added an example for the config.dump feature
  • fixed various formatting inconsistencies

Not sure who I need to include for reviewers here - I assume this also needs to go into "src" reviewers? Don't want to add before I understand whether I'm spamming anyone with this... feedback welcome!

I'm adding jhb since I realize - after reading MAINTAINERS - he should obviously know about this as well. Again - any feedback appreciated.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

This revision is now accepted and ready to land.Feb 16 2024, 10:57 PM
pauamma_gundo.com added inline comments.
usr.sbin/bhyve/bhyve.8
343

Correcting section reference to Sx instead of Cm.

This revision now requires review to proceed.Feb 18 2024, 7:50 AM
usr.sbin/bhyve/bhyve.8
373

New sentences start on new lines.

usr.sbin/bhyve/bhyve.8
373

Thanks for the feedback! I'll post an update in a moment.

usr.sbin/bhyve/bhyve.8
579–580

I think we don't need .Pp after .Ss

thanks for the feedback!

Cleaned up superfluous .Pp

usr.sbin/bhyve/bhyve.8
613

The new sentence should start on a new line.

999

The new sentence should start on a new line.

Fixed line breaks. Thanks for the feedback!

Would it be possible to update the patch so it applies in recent current?
There were some changes in the manual page on February.

Chris, rather than overwrite your review, I rebased your work on top of the latest of the main branch and created new review in https://reviews.freebsd.org/D44977. The commit message is based on your summary in D43940. If everything looks good to you there, I'll commit.