Added some documentation of fuse internals.

diff --git a/doc/Doxyfile b/doc/Doxyfile
index 654c8af469c8bc1c94dbd83a08f817e74c26053a..811e68b59bcf28248fd4cb5417cc551307733bdc 100644 (file)
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -795,6 +795,8 @@ DOCSET_BUNDLE_ID       = org.doxygen.Project
 
 HTML_DYNAMIC_SECTIONS  = YES
 
+HTML_EXTRA_FILES = doc/fast17-vangoor.pdf
+
 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
 # be used to specify the file name of the resulting .chm file. You
 # can add a path in front of the file if the result should not be

diff --git a/doc/fast17-vangoor.pdf b/doc/fast17-vangoor.pdf
new file mode 100644 (file)
index 0000000..cef7237
Binary files /dev/null and b/doc/fast17-vangoor.pdf differ

diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index dc64868d5a621de9c9b74031b0fa4ed9c1d2ae5c..36ba3bcba268a8a9e74f355438b8954f87d7a3ed 100644 (file)
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -35,5 +35,20 @@ href="files.html">examples</a> directory. A good starting point are
 hello.c (for the high-level API) and hello_ll.c (for the low-level
 API).
 
+## FUSE internals ##
+
+The authoritative source of information about libfuse internals
+(including the protocol used for communication with the FUSE kernel
+module) is the source code.
+
+However, some people have kindly documented different aspects of FUSE
+in a more beginner friendly way. While this information is
+increasingly out of date, it still provides a good overview:
+
+- Bharat Vangoor et al have included an overview of the FUSE internals
+  in a <a href="fast17-vangoor.pdf">paper evaluating FUSE performance</a>.
+
+- Some documentation of the kernel-userspace protocol is available on
+  the <a href="https://github.com/libfuse/libfuse/wiki/">libfuse wiki</a>.
 
 */