aboutsummaryrefslogtreecommitdiff
path: root/include/fuse.h
diff options
context:
space:
mode:
authorGravatar Miklos Szeredi <mszeredi@suse.cz>2013-07-17 15:58:53 +0200
committerGravatar Miklos Szeredi <mszeredi@suse.cz>2013-07-17 15:58:53 +0200
commit7dfb43254cc64044e75a5da4bbf02a86d110aee3 (patch)
treeffbca3caeae8b421efbdd27dcd01fa573ff381ed /include/fuse.h
parent95e71dd19ebf1ddf7e5285d21ba9001d44e30f7a (diff)
Documentation fixes
Diffstat (limited to 'include/fuse.h')
-rw-r--r--include/fuse.h39
1 files changed, 18 insertions, 21 deletions
diff --git a/include/fuse.h b/include/fuse.h
index c7647ce..b8a9307 100644
--- a/include/fuse.h
+++ b/include/fuse.h
@@ -114,7 +114,7 @@ struct fuse_operations {
*/
int (*mknod) (const char *, mode_t, dev_t);
- /** Create a directory
+ /** Create a directory
*
* Note that the mode argument may not have the type specification
* bits set, i.e. S_ISDIR(mode) can be false. To obtain the
@@ -589,7 +589,7 @@ struct fuse_context {
* @param op the file system operation
* @param user_data user data supplied in the context during the init() method
* @return 0 on success, nonzero on failure
- *
+ *
* Example usage, see hello.c
*/
/*
@@ -637,7 +637,7 @@ void fuse_destroy(struct fuse *f);
*
* @param f the FUSE handle
* @return 0 if no error occurred, -1 otherwise
- *
+ *
* See also: fuse_loop()
*/
int fuse_loop(struct fuse *f);
@@ -658,27 +658,24 @@ void fuse_exit(struct fuse *f);
*
* Calling this function requires the pthreads library to be linked to
* the application.
- *
- * Note: using fuse_loop() instead of fuse_loop_mt() means you are running in single-threaded mode,
- * and that you will not have to worry about reentrancy,
- * though you will have to worry about recursive lookups. In single-threaded mode, FUSE
- * holds a global lock on your filesystem, and will wait for one callback to return
- * before calling another. This can lead to deadlocks, if your script makes any attempt
- * to access files or directories in the filesystem it is providing.
- * (This includes calling stat() on the mount-point, statfs() calls from the 'df' command,
- * and so on and so forth.) It is worth paying a little attention and being careful about this.
- *
- * Enabling multiple threads, by using fuse_loop_mt(), will cause FUSE to make multiple simultaneous
- * calls into the various callback functions given by your fuse_operations record.
- *
- * If you are using multiple threads, you can enjoy all the parallel execution and interactive
- * response benefits of threads, and you get to enjoy all the benefits of race conditions
- * and locking bugs, too. Ensure that any code used in the callback funtion of fuse_operations
- * is also thread-safe.
+ *
+ * Note: using fuse_loop() instead of fuse_loop_mt() means you are running in
+ * single-threaded mode, and that you will not have to worry about reentrancy,
+ * though you will have to worry about recursive lookups. In single-threaded
+ * mode, FUSE will wait for one callback to return before calling another.
+ *
+ * Enabling multiple threads, by using fuse_loop_mt(), will cause FUSE to make
+ * multiple simultaneous calls into the various callback functions given by your
+ * fuse_operations record.
+ *
+ * If you are using multiple threads, you can enjoy all the parallel execution
+ * and interactive response benefits of threads, and you get to enjoy all the
+ * benefits of race conditions and locking bugs, too. Ensure that any code used
+ * in the callback funtion of fuse_operations is also thread-safe.
*
* @param f the FUSE handle
* @return 0 if no error occurred, -1 otherwise
- *
+ *
* See also: fuse_loop()
*/
int fuse_loop_mt(struct fuse *f);