From: Nikolaus Rath <Nikolaus@rath.org>
Date: Sun, 18 Sep 2016 03:10:21 +0000 (-0700)
Subject: Documentation improvements.
X-Git-Tag: fuse-3.0.0pre0~25
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=fb00891531f233613fea33827b87a181b3204a54;p=qemu-gpiodev%2Flibfuse.git

Documentation improvements.
---

diff --git a/include/fuse.h b/include/fuse.h
index 7f5daa8..c70d2fe 100644
--- a/include/fuse.h
+++ b/include/fuse.h
@@ -677,7 +677,10 @@ void fuse_destroy(struct fuse *f);
 int fuse_loop(struct fuse *f);
 
 /**
- * Exit from event loop
+ * Flag session as terminated
+ *
+ * This function will cause any running event loops to exit on
+ * the next opportunity.
  *
  * @param f the FUSE handle
  */
diff --git a/include/fuse_lowlevel.h b/include/fuse_lowlevel.h
index 4ae0b9c..2022cc6 100644
--- a/include/fuse_lowlevel.h
+++ b/include/fuse_lowlevel.h
@@ -1653,24 +1653,25 @@ int fuse_session_receive_buf(struct fuse_session *se, struct fuse_buf *buf,
 void fuse_session_destroy(struct fuse_session *se);
 
 /**
- * Exit a session.
+ * Flag a session as terminated.
  *
- * This function is invoked by the POSIX signal handlers, when registered using:
- * * fuse_set_signal_handlers()
+ * This function is invoked by the POSIX signal handlers, when
+ * registered using fuse_set_signal_handlers(). It will cause any
+ * running event loops to terminate on the next opportunity.
  *
  * @param se the session
  */
 void fuse_session_exit(struct fuse_session *se);
 
 /**
- * Reset the exited status of a session
+ * Reset the terminated flag of a session
  *
  * @param se the session
  */
 void fuse_session_reset(struct fuse_session *se);
 
 /**
- * Query the exited status of a session
+ * Query the terminated flag of a session
  *
  * @param se the session
  * @return 1 if exited, 0 if not exited