From 810df40a0625835ad17a0a5bf3232a8d1a68e680 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Mon, 10 Apr 2017 13:16:11 +0200
Subject: Implement vm startup and shutdown

---
 doc/manual.cli | 57 ++++++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 46 insertions(+), 11 deletions(-)

(limited to 'doc')

diff --git a/doc/manual.cli b/doc/manual.cli
index d5ab992..3617ca0 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -155,20 +155,19 @@ windows-vc_14-32-debug
 linux-gcc_6-cross-arm-eabi
 \
 
-\h#arch-machine-manifest|Machine Manifest|
+\h#arch-machine-header-manifest|Machine Header Manifest|
 
 \
 SYNOPSIS
 
 id:      <machine-id>
 name:    <machine-name>
-type:    <machine-type>
 summary: <string>
 \
 
-The build machine manifest describes the build machine on the build host (see
-the Build OS documentation for their origin and location). A list of machine
-manifests is also sent by \c{bbot} agents to controllers.
+The build machine header manifest contains basic information about a build
+machine on the build host. A list of machine header manifests is sent by
+\c{bbot} agents to controllers.
 
 \dl|
 
@@ -183,23 +182,59 @@ manifests is also sent by \c{bbot} agents to controllers.
 
   The machine name as described above.|
 
-\li|\n\c{type: <machine-type>}\n
-
-  The machine type. Valid values are \c{kvm} (QEMU/KVM virtual machine) and
-  \c{nspawn} (\c{systemd-nspawn} container). Note that this value is not sent
-  by agents to controllers.|
-
 \li|\n\c{summary: <string>}\n
 
   A one-line description of the machine. For example:
 
   \
+  id: windows_10-msvc_14-1.3
   name: windows_10-msvc_14
   summary: Windows 10 build 1607 with VC 14 update 3
   \
 
 ||
 
+\h#arch-machine-manifest|Machine Manifest|
+
+\
+SYNOPSIS
+
+id:      <machine-id>
+name:    <machine-name>
+summary: <string>
+
+type: <machine-type>
+mac:  <macaddr>
+\
+
+The build machine manifest contains the complete description of a build
+machine on the build host (see the Build OS documentation for their origin and
+location). The machine manifest starts with the machine manifest header. All
+the header values must appear before any non-header values.
+
+\dl|
+
+\li|\n\c{type: <machine-type>}\n
+
+  The machine type. Valid values are \c{kvm} (QEMU/KVM virtual machine) and
+  \c{nspawn} (\c{systemd-nspawn} container).|
+
+\li|\n\c{mac: <macaddr>}\n
+
+  Optional fixed MAC address for the machine in the hexadecimal,
+  comma-separated format. For example:
+
+  \
+  mac: de:ad:be:ef:de:ad
+  \
+
+  If it is not specified, then a random address is generated on the first
+  machine bootstrap which is then reused for each build/re-bootstrap. Note
+  that it you specify a fixed address, then the machine can only be used by a
+  single \c{bbot} agent.
+
+||
+
 
 \h#arch-task-manifest|Task Manifest|
 
-- 
cgit v1.1