blob: fd45379a6d46a19043701ed2c9262e4b74fa2342 [file] [log] [blame] [view]
Fxfs is a filesystem under active development. See the [RFC] for the motivation
and higher level design decisions.
Fxfs has rustdoc style documentation which can be generated and opened with
commands like:
```shell
# Configure the build to generate cargo output.
$ fx set core.x64 --with //src/storage/fxfs:tests --cargo-toml-gen
# Rebuild to actually generates cargo .toml files.
$ fx build
# Generate rustdoc.
$ fx rustdoc-link //src/storage/fxfs:lib
```
Note: The last line prints the documentation location, which depends on target.
[RFC]: /docs/contribute/governance/rfcs/0136_fxfs.md