aboutsummaryrefslogtreecommitdiff
path: root/example
diff options
context:
space:
mode:
authorGravatar Nikolaus Rath <Nikolaus@rath.org>2016-12-23 18:31:45 -0800
committerGravatar Nikolaus Rath <Nikolaus@rath.org>2016-12-23 18:31:45 -0800
commit8e69b19cdc7ca7218f468e7ebd10ac7a4b46c56a (patch)
treefa16100002de23470f99d7fe2f10cc5878743047 /example
parentd6e86a7c40ab715aeaf331c6d43749694763b924 (diff)
Added documentation and test case for null example
Diffstat (limited to 'example')
-rw-r--r--example/null.c13
1 files changed, 8 insertions, 5 deletions
diff --git a/example/null.c b/example/null.c
index 5e8ebda..bc99a84 100644
--- a/example/null.c
+++ b/example/null.c
@@ -8,14 +8,17 @@
/** @file
*
- * null.c - FUSE: Filesystem in Userspace
+ * This "filesystem" provides only a single file. The mountpoint
+ * needs to be a file rather than a directory. All writes to the
+ * file will be discarded, and reading the file always returns
+ * \0.
*
- * \section section_compile compiling this example
+ * Compile with:
*
- * gcc -Wall null.c `pkg-config fuse3 --cflags --libs` -o null
+ * gcc -Wall null.c `pkg-config fuse3 --cflags --libs` -o null
*
- * \section section_source the complete source
- * \include null.c
+ * ## Source code ##
+ * \include passthrough_fh.c
*/