From owner-dev-commits-src-main@freebsd.org Sun Apr 18 21:33:39 2021 Return-Path: Delivered-To: dev-commits-src-main@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 0454A5F6F11; Sun, 18 Apr 2021 21:33:39 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4FNjqk6dGKz4Zgj; Sun, 18 Apr 2021 21:33:38 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id D5707132F8; Sun, 18 Apr 2021 21:33:38 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 13ILXc1M067195; Sun, 18 Apr 2021 21:33:38 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 13ILXcJ1067194; Sun, 18 Apr 2021 21:33:38 GMT (envelope-from git) Date: Sun, 18 Apr 2021 21:33:38 GMT Message-Id: <202104182133.13ILXcJ1067194@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mateusz Piotrowski <0mp@FreeBSD.org> Subject: git: 7014cb239359 - main - bhyve.8: Improve emulation description of the -s flag MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: 0mp X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 7014cb2393594ee4a8389c65d507afacf729c041 Auto-Submitted: auto-generated X-BeenThere: dev-commits-src-main@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for the main branch of the src repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 18 Apr 2021 21:33:39 -0000 The branch main has been updated by 0mp (doc, ports committer): URL: https://cgit.FreeBSD.org/src/commit/?id=7014cb2393594ee4a8389c65d507afacf729c041 commit 7014cb2393594ee4a8389c65d507afacf729c041 Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2021-04-18 21:08:39 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2021-04-18 21:33:23 +0000 bhyve.8: Improve emulation description of the -s flag - Set width of the list to the longest key word for readability. - Separate descriptions of amd_hostbridge and hostbridge emulations. Also, wordsmith their descriptions for consistency with other entries. - Use Cm instead of Li for command modifiers. - Do not stylize AMD with Li, there's no need to do it. - Mention COM3 and COM4 in the definition of lpc. - Fix a typo in the definition of ahci-hd ("hard drive" instead of "hard-drive"). MFC after: 2 weeks --- usr.sbin/bhyve/bhyve.8 | 54 +++++++++++++++++++++++++------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/usr.sbin/bhyve/bhyve.8 b/usr.sbin/bhyve/bhyve.8 index 8e1a33ea4b42..6db14afa07c3 100644 --- a/usr.sbin/bhyve/bhyve.8 +++ b/usr.sbin/bhyve/bhyve.8 @@ -281,53 +281,53 @@ The .Ar emulation argument can be one of the following: -.Bl -tag -width 10n -.It Li hostbridge | Li amd_hostbridge -.Pp -Provide a simple host bridge. +.Bl -tag -width "amd_hostbridge" +.It Cm hostbridge +A simple host bridge. This is usually configured at slot 0, and is required by most guest operating systems. -The -.Li amd_hostbridge -emulation is identical but uses a PCI vendor ID of -.Li AMD . -.It Li passthru +.It Cm amd_hostbridge +Emulation identical to +.Cm hostbridge +using a PCI vendor ID of AMD. +.It Cm passthru PCI pass-through device. -.It Li virtio-net +.It Cm virtio-net Virtio network interface. -.It Li virtio-blk +.It Cm virtio-blk Virtio block storage interface. -.It Li virtio-scsi +.It Cm virtio-scsi Virtio SCSI interface. -.It Li virtio-9p +.It Cm virtio-9p Virtio 9p (VirtFS) interface. -.It Li virtio-rnd +.It Cm virtio-rnd Virtio RNG interface. -.It Li virtio-console +.It Cm virtio-console Virtio console interface, which exposes multiple ports to the guest in the form of simple char devices for simple IO between the guest and host userspaces. -.It Li ahci +.It Cm ahci AHCI controller attached to arbitrary devices. -.It Li ahci-cd +.It Cm ahci-cd AHCI controller attached to an ATAPI CD/DVD. -.It Li ahci-hd -AHCI controller attached to a SATA hard-drive. -.It Li e1000 +.It Cm ahci-hd +AHCI controller attached to a SATA hard drive. +.It Cm e1000 Intel e82545 network interface. -.It Li uart +.It Cm uart PCI 16550 serial device. -.It Li lpc -LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports, a boot ROM, and, +.It Cm lpc +LPC PCI-ISA bridge with COM1, COM2, COM3, and COM4 16550 serial ports, +a boot ROM, and, optionally, the debug/test device. The LPC bridge emulation can only be configured on bus 0. -.It Li fbuf +.It Cm fbuf Raw framebuffer device attached to VNC server. -.It Li xhci +.It Cm xhci eXtensible Host Controller Interface (xHCI) USB controller. -.It Li nvme +.It Cm nvme NVM Express (NVMe) controller. -.It Li hda +.It Cm hda High Definition Audio Controller. .El .Pp