From f1c26f2cbdb25da7292ea83446b2ca482973ecb5 Mon Sep 17 00:00:00 2001
From: Serge Hallyn <serge.hallyn@ubuntu.com>
Date: Thu, 15 May 2014 14:33:47 +0000
Subject: [PATCH] lxc.container.conf: document the type: lxc.rootfs conventions

Signed-off-by: Serge Hallyn <serge.hallyn@ubuntu.com>
Acked-by: Dwight Engen <dwight.engen@oracle.com>
---
 doc/lxc.container.conf.sgml.in | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/doc/lxc.container.conf.sgml.in b/doc/lxc.container.conf.sgml.in
index 6e9688971..39de1cc87 100644
--- a/doc/lxc.container.conf.sgml.in
+++ b/doc/lxc.container.conf.sgml.in
@@ -876,6 +876,20 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 	      specified, the container shares its root file system
 	      with the host.
 	    </para>
+	    <para>
+          For directory or simple block-device backed containers,
+          a pathname can be used.  If the rootfs is backed by a nbd
+          device, then <filename>nbd:file:1</filename> specifies that
+          <filename>file</filename> should be attached to a nbd device,
+          and partition 1 should be mounted as the rootfs.
+          <filename>nbd:file</filename> specifies that the nbd device
+          itself should be mounted.  <filename>overlayfs:/lower:/upper</filename>
+          specifies that the rootfs should be an overlay with <filename>/upper</filename>
+          being mounted read-write over a read-only mount of <filename>/lower</filename>.
+          <filename>aufs:/lower:/upper</filename> does the same using aufs in place
+          of overlayfs. <filename>loop:/file</filename> tells lxc to attach
+          <filename>/file</filename> to a loop device and mount the loop device.
+	    </para>
 	  </listitem>
 	</varlistentry>
 
-- 
2.39.5