Document needs-external-kernel template option.

[mclu.git] / mclu.pod

diff --git a/mclu.pod b/mclu.pod
index e82f14c..63b9b20 100644 (file)
--- a/mclu.pod
+++ b/mclu.pod
@@ -322,6 +322,14 @@ guest.  Abbreviations like C<1G> are supported.
 The template MAY print the minimum disk space required by this guest.
 Abbreviations like C<10G> are supported.
 
+=item needs-external-kernel
+
+The template MAY print C<yes> or C<1>.  If it does so then after the
+guest has been built, L<virt-get-kernel(1)> is run to extract the
+kernel and initrd from the guest, and these are used to boot the guest
+with an external kernel and initrd (ie. using the libvirt
+C<E<lt>kernelE<gt>> and C<E<lt>initrdE<gt>> directives).
+
 =item network-model
 
 The template MAY print the network type supported by this guest.