Haiku/haiku
Haiku/haiku
1
0
Fork 0
mirror of https://review.haiku-os.org/haiku synced 2025-02-02 03:36:14 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
haiku/docs/develop/file_systems/befs/resources.rst

17 lines
704 B
ReStructuredText
Raw Normal View History

Generate developer docs with Sphinx An effort was started some time ago to consolidate all internal documentation in the git tree. However, this was just an accumulation of files in various formats without any strucutre or way to browse it, which results in no one even knowing that we have docs here. This converts most of the files to restructuredtext and uses Sphinx to generate an HTML browsable user manual (with a table of content and a first attempt to put things in a global hierarchy). There are almost no changes to the documentation content in this commit (some obviously obsolete things were removed). The plan is to get the toolchain up and running to make these docs easily available, and only then see about improving the content. We can migrate some things off the wiki and website, and rework the table of contents to have some more hierarchy levels because currently it's a bit messy. Change-Id: I924ac9dc6e753887ab56f18a09bdb0a1e1793bfd Reviewed-on: https://review.haiku-os.org/c/haiku/+/4370 Reviewed-by: Niels Sascha Reedijk <niels.reedijk@gmail.com>
2021-08-24 17:45:36 +02:00
The Be File System
================================
Probably the best resource for a description of the inner workings of
BFS is the book "Practical File System Design with the Be File System"
written by Dominic Giampaolo and published by Morgan Kaufmann
Publishers. Although that book is out of print, it's available at the
`Haiku web
site <https://www.haiku-os.org/legacy-docs/practical-file-system-design.pdf>`__.
If you prefer to see how it works in code, please have a look at
`Haiku's BFS
implementation <https://git.haiku-os.org/haiku/tree/src/add-ons/kernel/file_systems/bfs>`__.
If you are interested in the Haiku file system API, please refer to its
documentation as part of the Haiku book.
Copy Permalink