docs: Add support page for libvirt on macOS

Signed-off-by: Roman Bolshakov <r.bolshakov@yadro.com>
Signed-off-by: Andrea Bolognani <abologna@redhat.com>
Tested-by: Brad Laue <brad@brad-x.com>
Tested-by: Christophe Fergeau <cfergeau@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>

diff --git a/docs/docs.html.in b/docs/docs.html.in
index 8132090762b083c57c2706147961adacf88f9402..225827b6933e89c677e6444d536238af335f3e0a 100644 (file)
--- a/docs/docs.html.in
+++ b/docs/docs.html.in
@@ -16,6 +16,9 @@
         <dt><a href="windows.html">Windows</a></dt>
         <dd>Downloads for Windows</dd>
 
+        <dt><a href="macos.html">macOS</a></dt>
+        <dd>Working with libvirt on macOS</dd>
+
         <dt><a href="migration.html">Migration</a></dt>
         <dd>Migrating guests between machines</dd>
 

diff --git a/docs/index.html.in b/docs/index.html.in
index 2c4aa7c6d044b1c1c3daa02c39f05a78ccaea812..3c065badb7f982d198db3a02e607c43272d5a2c4 100644 (file)
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -28,7 +28,8 @@
           <a href="drvlxc.html">LXC</a>,
           <a href="drvbhyve.html">BHyve</a> and
           <a href="drivers.html">more</a></li>
-        <li>targets Linux, FreeBSD, <a href="windows.html">Windows</a> and macOS</li>
+        <li>targets Linux, FreeBSD, <a href="windows.html">Windows</a> and
+          <a href="macos.html">macOS</a></li>
         <li>is used by many <a href="apps.html">applications</a></li>
       </ul>
       <p>Recent / forthcoming <a href="news.html">release changes</a></p>

diff --git a/docs/macos.rst b/docs/macos.rst
new file mode 100644 (file)
index 0000000..84ff819
--- /dev/null
+++ b/docs/macos.rst
@@ -0,0 +1,44 @@
+.. role:: since
+
+=============
+macOS support
+=============
+
+.. contents::
+
+Libvirt works both as client (for most drivers) and server (for the
+`QEMU driver <drvqemu.html>`__) on macOS.
+
+:since:`Since 8.1.0`, the "hvf" domain type can be used to run
+hardware-accelerated VMs on macOS via
+`Hypervisor.framework <https://developer.apple.com/documentation/hypervisor>`__.
+QEMU version 2.12 or newer is needed for this to work.
+
+
+Installation
+============
+
+libvirt client (virsh), server (libvirtd) and development headers can be
+installed from `Homebrew <https://brew.sh>`__:
+
+::
+
+   brew install libvirt
+
+
+Running libvirtd locally
+========================
+
+The server can be started manually:
+
+::
+
+   $ libvirtd
+
+or on system boot:
+
+::
+
+   $ brew services start libvirt
+
+Once started, you can use virsh as you would on Linux.

diff --git a/docs/meson.build b/docs/meson.build
index 54bba5e1b1fcfbaa1744935e2b587220e15d1948..7e070d68adf518ea9a2ff2b53c4ea3ceb3cdcf23 100644 (file)
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -106,6 +106,7 @@ docs_rst_files = [
   'hacking',
   'libvirt-go',
   'libvirt-go-xml',
+  'macos',
   'migration',
   'newreposetup',
   'pci-addresses',