git: 1103bc026f72 - stable/13 - bhyve.8: Improve the description and synopsis of -l

Mateusz Piotrowski 0mp at FreeBSD.org
Mon Aug 16 09:03:58 UTC 2021


The branch stable/13 has been updated by 0mp (doc, ports committer):

URL: https://cgit.FreeBSD.org/src/commit/?id=1103bc026f729f0c0f1a30259a2b3d343a064035

commit 1103bc026f729f0c0f1a30259a2b3d343a064035
Author:     Mateusz Piotrowski <0mp at FreeBSD.org>
AuthorDate: 2021-04-18 19:41:15 +0000
Commit:     Mateusz Piotrowski <0mp at FreeBSD.org>
CommitDate: 2021-08-16 08:15:44 +0000

    bhyve.8: Improve the description and synopsis of -l
    
    - Describe "-l help" separately for readability.
    - List all the supported comX devices explicitly
    - Use Cm instead of Ar for command modifiers (i.e., literal values a
      user can specify as an argument to the command).
    - Explain where to get more information about the possible values of the
      conf argument.
    
    MFC after:      2 weeks
    
    (cherry picked from commit 4c08b978b276f8cfc25f72715e97898f629f7f89)
---
 usr.sbin/bhyve/bhyve.8 | 21 +++++++++++++--------
 1 file changed, 13 insertions(+), 8 deletions(-)

diff --git a/usr.sbin/bhyve/bhyve.8 b/usr.sbin/bhyve/bhyve.8
index d38a9487abef..3105dbca016a 100644
--- a/usr.sbin/bhyve/bhyve.8
+++ b/usr.sbin/bhyve/bhyve.8
@@ -166,19 +166,24 @@ value.
 Blank lines and lines starting with
 .Sq #
 are ignored.
-.It Fl l Op Ar help|lpcdev Ns Op , Ns Ar conf
+.It Fl l Cm help
+Print a list of supported LPC devices.
+.It Fl l Ar lpcdev Ns Op Cm \&, Ns Ar conf
 Allow devices behind the LPC PCI-ISA bridge to be configured.
 The only supported devices are the TTY-class devices
-.Ar com1
-through
-.Ar com4 ,
+.Cm com1 , com2 , com3 ,
+and
+.Cm com4 ,
 the boot ROM device
-.Ar bootrom ,
+.Cm bootrom ,
 and the debug/test device
-.Ar pc-testdev .
+.Cm pc-testdev .
 .Pp
-.Ar help
-print a list of supported LPC devices.
+The possible values for the
+.Ar conf
+argument are listed in the
+.Fl s
+flag description.
 .It Fl m Ar memsize Ns Op Ar K|k|M|m|G|g|T|t
 Guest physical memory size in bytes.
 This must be the same size that was given to


More information about the dev-commits-src-all mailing list