diff options
| -rw-r--r-- | doc/Doxyfile | 2 | ||||
| -rw-r--r-- | doc/fast17-vangoor.pdf | bin | 0 -> 599157 bytes | |||
| -rw-r--r-- | doc/mainpage.dox | 15 |
3 files changed, 17 insertions, 0 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile index 654c8af..811e68b 100644 --- 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 Binary files differnew file mode 100644 index 0000000..cef7237 --- /dev/null +++ b/doc/fast17-vangoor.pdf 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>. */ |