aboutsummaryrefslogtreecommitdiffstats
path: root/doc/mainpage.dox
diff options
context:
space:
mode:
authorNikolaus Rath <Nikolaus@rath.org>2017-09-17 09:35:43 +0100
committerNikolaus Rath <Nikolaus@rath.org>2017-09-17 09:35:43 +0100
commit109ab4fa5307dbbb28a787b88d0ec4a125dd00e7 (patch)
treeb4ac7b217100043177a22300cbb24cde56759768 /doc/mainpage.dox
parentcfdca8c6a0f901f409d0a66dd158bd6c8b470bb6 (diff)
downloadlibfuse-109ab4fa5307dbbb28a787b88d0ec4a125dd00e7.tar.gz
Added some documentation of fuse internals.
Diffstat (limited to 'doc/mainpage.dox')
-rw-r--r--doc/mainpage.dox15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index dc64868..36ba3bc 100644
--- 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>.
*/