vitalif
/
fusego
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Reworked the readme.

geesefs-0-30-9
Aaron Jacobs 2015-07-27 11:53:29 +10:00
parent 563f47c299
commit 9564710706
1 changed files with 20 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1,31 +1,30 @@
[![GoDoc](https://godoc.org/github.com/jacobsa/ogletest?status.svg)](https://godoc.org/github.com/jacobsa/fuse) [![GoDoc](https://godoc.org/github.com/jacobsa/ogletest?status.svg)](https://godoc.org/github.com/jacobsa/fuse)
This package allows for writing and mounting user-space file systems from Go. It This package allows for writing and mounting user-space file systems from Go.
is a wrapper around [bazil.org/fuse][bazil], which does the heavy lifting. It Install it as follows:
does not make use of the [bazil.org/fuse/fs][bazil-fs] sub-package, which allows
for something like an object-orientend representation of files and directories,
and contains a decent amount of canned behavior.
The chief improvements and/or differences from the bazil.org packages are: go get -u github.com/jacobsa/fuse
* No surprises in the form of magic/default behaviors. You must provide an Afterward, see the documentation for the following three packages:
implementation for every method in the interface. Embed a
`fuseutil.NotImplementedFileSystem` struct to have default implementations
that return `ENOSYS`.
* Every method, struct, and field is thoroughly documented. This may help you * Package [fuse][] provides support for mounting a new file system and
get your bearings in the world of FUSE, the Linux VFS, traditional file reading requests from the kernel.
system implementations, etc., all of which tend to be very poorly
documented.
* Support for arbitrary offsets in directory entries returned by `ReadDir`. * Package [fuseops][] enumerates the supported requests from the kernel, and
(The bazil.org package assumes that offsets must be counts of bytes.) provides documentation on their semantics.
The very large disadvantage over using the bazil.org packages is that many * Package [fuseutil][], in particular the `FileSystem` interface, provides a
features have not yet been exposed. convenient way to create a file system type and export it to the kernel via
`fuse.Mount`.
Make sure to see the sub-packages of the [samples][] package. Make sure to also see the sub-packages of the [samples][] package for examples
and tests.
[bazil]: http://godoc.org/bazil.org/fuse This package owes its inspiration and most of its kernel-related code to
[bazil-fs]: http://godoc.org/bazil.org/fuse/fs [bazil.org/fuse][bazil].
[fuse]: http://godoc.org/github.com/jacobsa/fuse
[fuseops]: http://godoc.org/github.com/jacobsa/fuse/fuseops
[fuseutil]: http://godoc.org/github.com/jacobsa/fuse/fuseutil
[samples]: http://godoc.org/github.com/jacobsa/fuse/samples [samples]: http://godoc.org/github.com/jacobsa/fuse/samples
[bazil]: http://godoc.org/bazil.org/fuse