[Ocfs2-commits] mfasheh commits r2366 - trunk

[svn-commits at oss.oracle.com]

Author: mfasheh
Signed-off-by: manish
Date: 2005-06-03 17:32:19 -0500 (Fri, 03 Jun 2005)
New Revision: 2366

Modified:
   trunk/dlmfs.txt
Log:
* doc update

Signed-off-by: manish



Modified: trunk/dlmfs.txt
===================================================================
--- trunk/dlmfs.txt	2005-06-03 22:26:10 UTC (rev 2365)
+++ trunk/dlmfs.txt	2005-06-03 22:32:19 UTC (rev 2366)
@@ -1,6 +1,6 @@
 dlmfs
 ==================
-A minimal dlm userspace interface implemented via a virtual file
+A minimal DLM userspace interface implemented via a virtual file
 system.
 
 dlmfs is built with OCFS2 as it requires most of its infrastructure.
@@ -21,8 +21,8 @@
 
 Caveats
 =======
-- Right now it only works with the OCFS2 dlm, though support for other
-  dlms should not be a major issue.
+- Right now it only works with the OCFS2 DLM, though support for other
+  DLM implementations should not be a major issue.
 
 Mount options
 =============
@@ -53,7 +53,7 @@
 Please see the ocfs2_hb_ctl and mkfs.ocfs2 manual pages distributed
 with ocfs2-tools.
 
-Once you're heartbeating, dlm lock 'domains' can be easily created /
+Once you're heartbeating, DLM lock 'domains' can be easily created /
 destroyed and locks within them accessed.
 
 Locking
@@ -64,7 +64,7 @@
 system calls and presents a more traditional locking api.
 
 dlmfs handles lock caching automatically for the user, so a lock
-request for an already acquired lock will not generate another dlm
+request for an already acquired lock will not generate another DLM
 call. Userspace programs are assumed to handle their own local
 locking.
 
@@ -76,8 +76,8 @@
 
 Lock value blocks can be read and written to a resource via read(2)
 and write(2) against the fd obtained via your open(2) call. The
-maximum currently supported LVB length is 64 bytes (though that is a
-dlm limitation). Through this mechanism, users of dlmfs can share
+maximum currently supported LVB length is 64 bytes (though that is an
+OCFS2 DLM limitation). Through this mechanism, users of dlmfs can share
 small amounts of data amongst their nodes.
 
 mkdir(2) signals dlmfs to join a domain (which will have the same name
@@ -98,7 +98,7 @@
 
 Open Flag     Lock Request Type
 ---------     -----------------
-O_RDONLY      Read Only
+O_RDONLY      Shared Read
 O_RDWR        Exclusive
 
 Open Flag     Resulting Locking Behavior
@@ -116,9 +116,15 @@
 supported locally as well. This means you can use them to restrict
 access to the resources via dlmfs on your local node only.
 
-The resource LVB may be read from the fd in either Read Only or
+The resource LVB may be read from the fd in either Shared Read or
 Exclusive modes via the read(2) system call. It can be written via
 write(2) only when open in Exclusive mode.
 
 Once written, an LVB will be visible to other nodes who obtain Read
 Only or higher level locks on the resource.
+
+See Also
+========
+http://opendlm.sourceforge.net/cvsmirror/opendlm/docs/dlmbook_final.pdf
+
+For more information on the VMS distributed locking API.