Commits

evhan  committed 68873cf

Doc update

  • Participants
  • Parent commits b918a1f

Comments (0)

Files changed (2)

 Installation
 ------------
 Installation requires the libfuse library and headers (API version 26)
-and CHICKEN 4.8.0 or newer.
+and a development snapshot of CHICKEN version 4.8.2 or newer.
 
     $ git clone git://bitbucket.org/evhan/chicken-fuse.git
     $ cd chicken-fuse
-    $ chicken-install
+    $ chicken-install -test
 
 Documentation
 -------------
 Documentation is available on the CHICKEN [wiki][], at [chickadee][],
 and under the `doc/` directory.
 
-Usage examples can be found in the `examples/` directory.
+Usage examples can be found in the `test/` and `examples/` directories.
 
 [wiki]: http://wiki.call-cc.org/egg/fuse
 [chickadee]: http://api.call-cc.org/doc/fuse
 ------
 Evan Hanson <evhan@foldling.org>
 
+Lots of thanks to Jörg Wittenberger and Ivan Raikov.
+
 License
 -------
 3-Clause BSD. See LICENSE for details.

File doc/fuse.wiki

 A [[http://fuse.sourceforge.net/|FUSE]] interface.
 
 Installation requires the libfuse library and headers (API version 26)
-and CHICKEN 4.8.0 or newer.
+and a development snapshot of CHICKEN version 4.8.2 or newer.
 
 The source for this extension is available at
 [[https://bitbucket.org/evhan/chicken-fuse|Bitbucket]].
 '''This extension is not yet stable.''' Its interface is subject to
 change, and I'd appreciate feedback and suggestions regarding the API.
 
+==== Requirements
+
+* [[/egg/concurrent-native-callbacks|concurrent-native-callbacks]]
+* [[/egg/foreigners|foreigners]]
+* [[/egg/matchable|matchable]]
+
 ==== Platform Notes
 
 '''This extension is only officially supported on Linux.''' It has also
 been installed successfully on OpenBSD, FreeBSD and Mac OS X, but tested
 far less thoroughly on those platforms.
 
-On Linux, each filesystem operation is executed in its own green
-({{srfi-18}}) thread.
-
-On other platforms, filesystem operations are synchronous
-({{start-filesystem}} is single-threaded) and {{stop-filesystem}} is not
-supported.
+Each filesystem is executed in a separate native thread and communicates
+with the CHICKEN runtime via pipe, per
+([[/egg/concurrent-native-callbacks|concurrent-native-callbacks]]).
 
 === API
 
 
 {{path}} should be a pathname string indicating an empty directory.
 
-On success, this procedure will block until the filesystem is unmounted,
-at which point it will return a non-false value. This may occur due to a
-signal, a call to {{stop-filesystem}}, or a user manually running
-{{fusermount -u path}}.
+On success, this procedure will block until the filesystem is stopped.
+This may occur due to a signal (either {{signal/term}} or
+{{signal/int}}), or a call to {{stop-filesystem!}}.
 
 On failure, it will return {{#f}} immediately.
 
 ''always'' return with a suitable {{errno(3)}} integer value. Failure to
 do so may result in orphaned mounts, infinite loops, and locusts.
 
-<procedure>(stop-filesystem path filesystem) -> void</procedure>
+<procedure>(stop-filesystem! path filesystem) -> void</procedure>
 
 Unmount {{filesystem}} from the given {{path}}.
 
 If the given {{filesystem}} isn't currently mounted at {{path}}, this
 procedure is a noop.
 
-On other platforms, this procedure is a noop.
-
 <constant>file/fifo</constant>
 <constant>file/chr</constant>
 <constant>file/blk</constant>