From: Ralph Ronnquist <ralph.ronnquist@gmail.com>
Date: Sun, 3 Apr 2022 12:13:09 +0000 (+1000)
Subject: added examples
X-Git-Tag: v0.1.5~3
X-Git-Url: https://git.rrq.au/?a=commitdiff_plain;h=51abada33ae4c5733285832669f5cb4609fa7773;p=rrq%2Foverlay-boot.git

added examples
---

diff --git a/overlay-diskfile.8.adoc b/overlay-diskfile.8.adoc
index 8f39cbb..739e05b 100644
--- a/overlay-diskfile.8.adoc
+++ b/overlay-diskfile.8.adoc
@@ -4,6 +4,7 @@ overlay-diskfile(8)
 :revdate: {sys:date "+%Y-%m-%d %H:%M:%S"}
 :COLON: :
 :EQUALS: =
+:BANG: !
 
 NAME
 ----
@@ -11,8 +12,7 @@ overlay-diskfile - Support for using diskfile filesystem.
 
 SYNOPSIS
 --------
-LOWER=!*overlay-diskfile* _mount/path_ [ _diskfile_ [ _index_ ] ]
-UPPER=!*overlay-diskfile* _mount/path_ [ _diskfile_ [ _index_ ] ]
+*overlay-diskfile* _mount/path_ [ _diskfile_ [ _index_ ] ]
 
 DESCRIPTION
 -----------
@@ -60,7 +60,7 @@ LOWER=!overlay-diskfile mnt/some/path disk.img 2
 The above mounts the second partition onto +mnt+ and provides the path
 +mnt/some/path+ that as the LOWER filesystem.
 
-.Use a while diskfile as UPPER and WORK.
+.Use second partition diskfile filesystem subtrees for UPPER and WORK.
 ====
 ----
 UPPER=!overlay-diskfile mnt/some/upper/path disk.img 2
@@ -69,7 +69,8 @@ WORK= mnt/some/work/path
 ====
 
 The above mounts the second partition of disk.img and uses
-+mnt/some/upper/path+ as UPPER and +mnt/some/work/path+ as WORK.
++mnt/some/upper/path+ as UPPER and +mnt/some/work/path+ as WORK. Note
+that UPPER and WORK must always be subtrees from the same filesystem.
 
 
 SEE ALSO