[Bug 271134] bhyve(8), bhyvectl(8), bhyve(4), bhyve_config(5): manual pages cleanup

[bugzilla-noreply]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=271134
Bug 271134 depends on bug 266336, which changed state.

Bug 266336 Summary: Angle brackets < and > misrepresented as underscore 
characters in online manual pages
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=266336

   What|Removed |Added

 Status|In Progress |Closed
 Resolution|--- |FIXED

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug 271134] bhyve(8), bhyvectl(8), bhyve(4), bhyve_config(5): manual pages cleanup

[bugzilla-noreply]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=271134

Jason Mann  changed:

   What|Removed |Added

 CC||jason.m...@gmail.com

--- Comment #9 from Jason Mann  ---
There is a malformed section in the man page, just before the CONFIGURATION
VARIABLES section.  The lines from "Set the universally unique identifier"
downwards to the end of the section are missing their option arguments

> HD Audio  device backends:
> 
> o   [play=playback][,rec=recording]
> 
> Configuration options are defined as follows:
> 
> play Playback device, typically /dev/dsp0.
> 
> rec  Recording device, typically /dev/dsp0.
> Set the universally unique identifier (UUID) in the guest's System Man-
> agement BIOS System Information structure.  By default a UUID is gener-
> ated from the host's hostname and vmname.
> RTC keeps UTC time.
> Force virtio PCI  device emulations to use  MSI  interrupts  instead  of
> MSI-X interrupts.
> Ignore accesses to unimplemented  Model Specific Registers (MSRs).  This
> is intended for debug purposes.
> The guest's local APIC is configured in x2APIC mode.
> Disable MPtable generation.
> Alphanumeric  name  of the guest.  This should be the same as that cre-
> ated by bhyveload(8).
>
> CONFIGURATION VARIABLES 

Should it not be as follows:

> -USet the universally unique identifier...
> -uRTC keeps UTC time.
> -WForce virtio PCI...
> -wIgnore access to unimplemented Model Specific Registers...
> -aThe guest's local APIC is configured in x2APIC mode.
> -YDisable MPtable generation.
> vmnameAlphanumeric name of the guest. ...

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug 271134] bhyve(8), bhyvectl(8), bhyve(4), bhyve_config(5): manual pages cleanup

[bugzilla-noreply]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=271134

--- Comment #8 from Chris Moerz  ---
Related to this topic, there's now a review for improving the bhyve man page
further:
https://reviews.freebsd.org/D43940

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug 271134] bhyve(8), bhyvectl(8), bhyve(4), bhyve_config(5): manual pages cleanup

[bugzilla-noreply]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=271134

Chris Moerz  changed:

   What|Removed |Added

 CC||free...@ny-central.org

--- Comment #7 from Chris Moerz  ---
I am looking at integrating this into a set of "features" for a MVP that
delivers improvements to bhyve out of the Enterprise Working Group
(https://wiki.freebsd.org/EnterpriseWorkingGroup). While the setting is
originating out of "enterprise stakeholder" needs, I do believe the related
Venn diagram has a considerable overlap with regular users when it comes to
documentation - so everyone would stand to benefit from some work on this.

If anyone wants to add missing points, have a more in-depth conversation or has
already started working on a patch, please do get in touch with me.

We had a conversation about this in this week's regular bhyve call and there
was also feedback in direction to the handbook.

We're still in the stage of "what" to do; the "who" and "how" would follow
later once we better understand whether there's volunteers to get things done
or if we need funding help from the Foundation.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug 271134] bhyve(8), bhyvectl(8), bhyve(4), bhyve_config(5): manual pages cleanup

[bugzilla-noreply]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=271134

Matt Simerson  changed:

   What|Removed |Added

 CC||m...@tnpi.net

--- Comment #6 from Matt Simerson  ---
While someone is in there fixing
https://man.freebsd.org/cgi/man.cgi?query=bhyve&sektion=8&manpath=freebsd-release,
also see the description of Options -k, half of the description is dislocated
to the -K option.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug 271134] bhyve(8), bhyvectl(8), bhyve(4), bhyve_config(5): manual pages cleanup

[bugzilla-noreply]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=271134

Peter Grehan  changed:

   What|Removed |Added

 CC||gre...@freebsd.org

--- Comment #5 from Peter Grehan  ---
(In reply to Graham Perrin from comment #3)

At the time bhyve was written, it was commonplace to have to rebuild an o/s
kernel with paravirtualized drivers and/or other components to allow it to run
under a hypervisor - "modified".

This isn't really the case anymore so that sentence could be removed.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug 271134] bhyve(8), bhyvectl(8), bhyve(4), bhyve_config(5): manual pages cleanup

[bugzilla-noreply]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=271134

--- Comment #4 from Yuri Pankov  ---
Re: angle brackets, those should just be removed from bhyvectl(8) man page. 
Remember that mdoc is semantic markup language, and if you want arguments (.Ar)
to be represented as "" if formatted output (e.g. if you have console
that does not support underline), it's the utility that formats man page (e.g.
mandoc or whatever is used for web page) that needs to be modified.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug 271134] bhyve(8), bhyvectl(8), bhyve(4), bhyve_config(5): manual pages cleanup

[bugzilla-noreply]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=271134

--- Comment #3 from Graham Perrin  ---
> bhyve is a virtual machine monitor that is hosted by FreeBSD. It is used 
> to host unmodified guest operating systems on top of FreeBSD.

What's meant by 'unmodified'?

What type of modification to a guest OS would make the OS unusable with bhyve?

-- 
You are receiving this mail because:
You are on the CC list for the bug.

[Bug 271134] bhyve(8), bhyvectl(8), bhyve(4), bhyve_config(5): manual pages cleanup

[bugzilla-noreply]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=271134

Graham Perrin  changed:

   What|Removed |Added

Summary|bhyve(8), bhyvectl(8),  |bhyve(8), bhyvectl(8),
   |bhyve_config(5): manual |bhyve(4), bhyve_config(5):
   |pages cleanup   |manual pages cleanup

--- Comment #2 from Graham Perrin  ---


> bhyve is considered experimental in FreeBSD.

Still true?



-- 
You are receiving this mail because:
You are on the CC list for the bug.