linux-fsdevel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Erez Zadok <ezk@cs.sunysb.edu>
To: akpm@linux-foundation.org
Cc: linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org,
	viro@ftp.linux.org.uk, hch@infradead.org,
	Erez Zadok <ezk@cs.sunysb.edu>, Jim Kissel <jlk@osml.eu>
Subject: [PATCH 2/2] Unionfs: clarify usage.txt mount options
Date: Fri, 14 Dec 2007 10:48:01 -0500	[thread overview]
Message-ID: <11976472822359-git-send-email-ezk@cs.sunysb.edu> (raw)
In-Reply-To: <11976472813872-git-send-email-ezk@cs.sunysb.edu>

CC: Jim Kissel <jlk@osml.eu>

Signed-off-by: Erez Zadok <ezk@cs.sunysb.edu>
---
 Documentation/filesystems/unionfs/usage.txt |   38 +++++++++++++++++++--------
 1 files changed, 27 insertions(+), 11 deletions(-)

diff --git a/Documentation/filesystems/unionfs/usage.txt b/Documentation/filesystems/unionfs/usage.txt
index a6b1aca..59c4f28 100644
--- a/Documentation/filesystems/unionfs/usage.txt
+++ b/Documentation/filesystems/unionfs/usage.txt
@@ -7,17 +7,32 @@ read-write branches, as well as insertion and deletion of branches anywhere
 in the fan-out.  To maintain Unix semantics, Unionfs handles elimination of
 duplicates, partial-error conditions, and more.
 
-# mount -t unionfs -o branch-option[,union-options[,...]] none MOUNTPOINT
+GENERAL SYNTAX
+==============
 
-The available branch-option for the mount command is:
+# mount -t unionfs -o <OPTIONS>,<BRANCH-OPTIONS> none MOUNTPOINT
+
+OPTIONS can be any legal combination one of:
+
+- ro		# mount file system read-only
+- rw		# mount file system read-write
+- remount	# remount the file system (see Branch Management below)
+- incgen	# increment generation no. (see Cache Consistency below)
+
+BRANCH-OPTIONS can be either (1) a list of branches given to the "dirs="
+option, or (2) a list of individual branch manipulation commands, described
+in the "Branch Management" section below.
+
+The syntax for the "dirs=" mount option is:
 
 	dirs=branch[=ro|=rw][:...]
 
-specifies a separated list of which directories compose the union.
-Directories that come earlier in the list have a higher precedence than
-those which come later. Additionally, read-only or read-write permissions of
-the branch can be specified by appending =ro or =rw (default) to each
-directory.
+The "dirs=" option takes a colon-delimited list of directories to compose
+the union, with an optional branch mode for each of those directories.
+Directories that come earlier (specified first, on the left) in the list
+have a higher precedence than those which come later.  Additionally,
+read-only or read-write permissions of the branch can be specified by
+appending =ro or =rw (default) to each directory.
 
 Syntax:
 
@@ -28,11 +43,12 @@ Example:
 	dirs=/writable_branch=rw:/read-only_branch=ro
 
 
-DYNAMIC BRANCH MANAGEMENT AND REMOUNTS
-======================================
+BRANCH MANAGEMENT
+=================
 
-You can remount a union and change its overall mode, or reconfigure the
-branches, as follows.
+Once you mount your union for the first time, using the "dirs=" option, you
+can then change the union's overall mode or reconfigure the branches, using
+the remount option, as follows.
 
 To downgrade a union from read-write to read-only:
 
-- 
1.5.2.2


  parent reply	other threads:[~2007-12-14 15:49 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-12-14 15:47 [GIT PULL -mm] 0/2 Unionfs updates/fixes/cleanups Erez Zadok
2007-12-14 15:48 ` [PATCH 1/2] Unionfs: avoid using drop_pagecache_sb in remount Erez Zadok
2007-12-14 15:48 ` Erez Zadok [this message]
2007-12-14 16:32   ` [PATCH 2/2] Unionfs: clarify usage.txt mount options Michael Tokarev
2007-12-14 16:36     ` Michael Tokarev
2007-12-14 16:58     ` Erez Zadok

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=11976472822359-git-send-email-ezk@cs.sunysb.edu \
    --to=ezk@cs.sunysb.edu \
    --cc=akpm@linux-foundation.org \
    --cc=hch@infradead.org \
    --cc=jlk@osml.eu \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=viro@ftp.linux.org.uk \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).