[Cluster-devel] cluster/dlm/man dlm_create_lockspace.3 libdlm.3

[teigland at sourceware.org]

CVSROOT:	/cvs/cluster
Module name:	cluster
Changes by:	teigland at sourceware.org	2007-08-17 16:25:54

Modified files:
	dlm/man        : dlm_create_lockspace.3 libdlm.3 

Log message:
	minor updates

Patches:
http://sourceware.org/cgi-bin/cvsweb.cgi/cluster/dlm/man/dlm_create_lockspace.3.diff?cvsroot=cluster&r1=1.3&r2=1.4
http://sourceware.org/cgi-bin/cvsweb.cgi/cluster/dlm/man/libdlm.3.diff?cvsroot=cluster&r1=1.2&r2=1.3

--- cluster/dlm/man/dlm_create_lockspace.3	2007/07/09 16:53:08	1.3
+++ cluster/dlm/man/dlm_create_lockspace.3	2007/08/17 16:25:54	1.4
@@ -6,10 +6,12 @@
  #include <libdlm.h>
 
 dlm_lshandle_t dlm_create_lockspace(const char *name, mode_t mode);
-dlm_lshandle_t dlm_new_lockspace(const char *name, mode_t mode, uint32_t flags);
+dlm_lshandle_t dlm_new_lockspace(const char *name, mode_t mode,
+                                 uint32_t flags);
 dlm_lshandle_t dlm_open_lockspace(const char *name);
-int dlm_close_lockspace(dlm_lshandle_t lockspace);
-int dlm_release_lockspace(const char *name, dlm_lshandle_t lockspace, int force);
+int dlm_close_lockspace(dlm_lshandle_t ls);
+int dlm_release_lockspace(const char *name, dlm_lshandle_t ls,
+                          int force);
 
 .fi
 .SH DESCRIPTION
@@ -37,17 +39,19 @@
 Any error returned by the open() system call
 .fi
 .SS
-int dlm_new_lockspace(const char *name, mode_t mode, uint32_t flags);
+int dlm_new_lockspace(const char *name, mode_t mode, uint32_t flags)
 .PP
 Performs the same function as 
 .B dlm_create_lockspace()
 above, but passes some creation flags to the call that affect the lockspace being created. Currently supported flags are:
 .nf
-DLM_LSFL_NODIR         
-DLM_LSFL_TIMEWARN
+DLM_LSFL_NODIR    the lockspace should not use a resource directory
+DLM_LSFL_TIMEWARN the dlm should emit warnings over netlink when locks
+                  have been waiting too long; required for deadlock
+                  detection
 .fi
 .SS
-int dlm_release_lockspace(const char *name, dlm_lshandle_t lockspace, int force)
+int dlm_release_lockspace(const char *name, dlm_lshandle_t ls, int force)
 .PP
 Deletes a lockspace. If the lockspace still has active locks then -1 will be returned and errno set to EBUSY. Both the lockspace handle /and/ the name must be specified. This call also closes the lockspace and stops the thread associated with the lockspace, if any.
 .br
@@ -60,25 +64,23 @@
 .nf
 EINVAL          An invalid parameter was passed to the call
 EPERM           Process does not have capability to release lockspaces
-EBUSY           The lockspace could not be freed because it still contains locks
-                and force was not set.
+EBUSY           The lockspace could not be freed because it still
+                contains locks and force was not set.
 .fi
 
 .SS
 dlm_lshandle_t dlm_open_lockspace(const char *name)
 .PP
 Opens an already existing lockspace and returns a handle to it.
-.br
+.PP
 Return codes:
-.br
 0 is returned if the call completed successfully. If not, -1 is returned and errno is set to an error returned by the open() system call
 .SS
-int dlm_close_lockspace(dlm_lshandle_t lockspace)
+int dlm_close_lockspace(dlm_lshandle_t ls)
 .br
 Close the lockspace. Any locks held by this process will be freed. If a thread is associated with this lockspace then it will be stopped.
 .PP
 Return codes:
-.br
 0 is returned if the call completed successfully. If not, -1 is returned and errno is set to one of the following:
 .nf
 EINVAL		lockspace was not a valid lockspace handle
--- cluster/dlm/man/libdlm.3	2007/07/09 09:29:57	1.2
+++ cluster/dlm/man/libdlm.3	2007/08/17 16:25:54	1.3
@@ -21,7 +21,8 @@
 pthreads is the normal way of using the DLM. This way you simply initialise the DLM's thread and all the AST routines will be delivered in that thread. You just call the dlm_lock() etc routines in the main line of your program.
 .br
 If you don't want to use pthreads or you want to handle the dlm callback ASTs yourself then you can get an FD handle to the DLM device and call 
-.B dlm_dispatch() on it whenever it becomes active. That was ASTs will be delivered in the context of the thread/process that called 
+.B dlm_dispatch()
+on it whenever it becomes active. That was ASTs will be delivered in the context of the thread/process that called 
 .B dlm_dispatch().