[libvirt] [PATCH] docs: document virt-host-validate bhyve support
Add an entry about virt-host-validate bhyve support and update the driver's page. --- docs/drvbhyve.html.in | 13 ++++++++++++- docs/news.xml | 10 +++++++++- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/docs/drvbhyve.html.in b/docs/drvbhyve.html.in index da6f1e0b2..64a1ff694 100644 --- a/docs/drvbhyve.html.in +++ b/docs/drvbhyve.html.in @@ -13,9 +13,20 @@ of bhyve are supported. In order to enable bhyve on your FreeBSD host, you'll need to load the <code>vmm</code> kernel module. Additionally, <code>if_tap</code> and <code>if_bridge</code> modules -should be loaded for networking support. +should be loaded for networking support. Also, <span class="since">since 3.2.0</span> the +<code>virt-host-validate(1)</code> supports the bhyve host validation and could be +used like this: </p> +<pre> +$ virt-host-validate bhyve + BHYVE: Checking for vmm module : PASS + BHYVE: Checking for if_tap module : PASS + BHYVE: Checking for if_bridge module : PASS + BHYVE: Checking for nmdm module : PASS +$ +</pre> + <p> Additional information on bhyve could be obtained on <a href="http://bhyve.org/">bhyve.org</a>. </p> diff --git a/docs/news.xml b/docs/news.xml index 951539575..57fafebb8 100644 --- a/docs/news.xml +++ b/docs/news.xml @@ -12,7 +12,15 @@ <libvirt> <release version="v3.2.0" date="unreleased"> <section title="New features"> - <change/> + <change> + <summary> + virt-host-validate: Add bhyve support + </summary> + <description> + Add support for validation of the bhyve hypervisor hosts + using the virt-host-validate tool. + </description> + </change> </section> <section title="Improvements"> <change> -- 2.11.0
On Sat, Mar 11, 2017 at 10:13:00PM +0400, Roman Bogorodskiy wrote:
Add an entry about virt-host-validate bhyve support and update the driver's page. --- docs/drvbhyve.html.in | 13 ++++++++++++- docs/news.xml | 10 +++++++++- 2 files changed, 21 insertions(+), 2 deletions(-)
diff --git a/docs/drvbhyve.html.in b/docs/drvbhyve.html.in index da6f1e0b2..64a1ff694 100644 --- a/docs/drvbhyve.html.in +++ b/docs/drvbhyve.html.in @@ -13,9 +13,20 @@ of bhyve are supported.
In order to enable bhyve on your FreeBSD host, you'll need to load the <code>vmm</code> kernel module. Additionally, <code>if_tap</code> and <code>if_bridge</code> modules -should be loaded for networking support. +should be loaded for networking support. Also, <span class="since">since 3.2.0</span> the +<code>virt-host-validate(1)</code> supports the bhyve host validation and could be +used like this: </p>
+<pre> +$ virt-host-validate bhyve + BHYVE: Checking for vmm module : PASS + BHYVE: Checking for if_tap module : PASS + BHYVE: Checking for if_bridge module : PASS + BHYVE: Checking for nmdm module : PASS +$ +</pre> + <p> Additional information on bhyve could be obtained on <a href="http://bhyve.org/">bhyve.org</a>. </p> diff --git a/docs/news.xml b/docs/news.xml index 951539575..57fafebb8 100644 --- a/docs/news.xml +++ b/docs/news.xml @@ -12,7 +12,15 @@ <libvirt> <release version="v3.2.0" date="unreleased"> <section title="New features"> - <change/> + <change> + <summary> + virt-host-validate: Add bhyve support + </summary> + <description> + Add support for validation of the bhyve hypervisor hosts + using the virt-host-validate tool. + </description> + </change> </section> <section title="Improvements"> <change> -- 2.11.0
The good thing about the new news file layout is that we can express freely what is the feature that was added and we don't have to copy-paste the restricted commit messages. So I, personally, like to have nicely formatted sentences in the summary (well, I like that even in the commit messages sometimes, but that's another story). I would go with: "Add(ed) bhyve support to the virt-host-validate tool" or even: "The virt-host-validate tool now supports bhyve hypervisor" for the summary and I would remove the description. But that's pretty subjective, so I'll leave the final decision up to you, just wanted to put it out there. ACK
-- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list
Martin Kletzander wrote:
On Sat, Mar 11, 2017 at 10:13:00PM +0400, Roman Bogorodskiy wrote:
Add an entry about virt-host-validate bhyve support and update the driver's page. --- docs/drvbhyve.html.in | 13 ++++++++++++- docs/news.xml | 10 +++++++++- 2 files changed, 21 insertions(+), 2 deletions(-)
The good thing about the new news file layout is that we can express freely what is the feature that was added and we don't have to copy-paste the restricted commit messages. So I, personally, like to have nicely formatted sentences in the summary (well, I like that even in the commit messages sometimes, but that's another story). I would go with:
"Add(ed) bhyve support to the virt-host-validate tool"
or even:
"The virt-host-validate tool now supports bhyve hypervisor"
for the summary and I would remove the description. But that's pretty subjective, so I'll leave the final decision up to you, just wanted to put it out there.
ACK
This looks like a valid point to me, and I like the latter sentence better. I've pushed that version, thanks! Roman Bogorodskiy
participants (2)
-
Martin Kletzander -
Roman Bogorodskiy