From 22a91d557c8b596e0856d9d1b4a8fad33462a35d Mon Sep 17 00:00:00 2001 From: Oscar Lesta Date: Wed, 21 Jan 2026 13:17:25 -0300 Subject: [PATCH] docs/develop: some minor fixes to file_systems/overview.rst. Change-Id: Ia710f87db372829fd1ccb84999cc1426091e1395 Reviewed-on: https://review.haiku-os.org/c/haiku/+/10248 Reviewed-by: Adrien Destugues Haiku-Format: Haiku-format Bot Tested-by: Commit checker robot --- docs/develop/file_systems/overview.rst | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/develop/file_systems/overview.rst b/docs/develop/file_systems/overview.rst index 955b0976cc..fea0e0b951 100644 --- a/docs/develop/file_systems/overview.rst +++ b/docs/develop/file_systems/overview.rst @@ -12,8 +12,8 @@ See docs/user/drivers/fs_interface.dox for more detailed documentation of this interface. It's important to note that while there may be some similarities in -the interface with that of other operations systems, one should not -make any assumptions about the desired behavior based soley on the +the interface with that of other operating systems, one should not +make any assumptions about the desired behavior based solely on the function prototypes defined in fs_interface.h. The following is a list of notes calling out some potential mistakes. @@ -46,9 +46,9 @@ For the early development steps, it is much easier to run the filesystem code in a more controlled environment. This can be achieved through the use of a "filesystem shell": a simple application that runs the filesystem code, and allows performing specific operations through a command line interface. It can be -executed on any platform (Haiku or another supported one such as Linux). +executed on Haiku, or on other supported platforms, such as Linux. -Example of fs_shell implementations are available under src/tests/add-ons/kernel/file_systems/ +Examples of fs_shell implementations are available under src/tests/add-ons/kernel/file_systems/ for the bfs and btrfs filesystems. For example, to build the fs_shell for btrfs, use @@ -74,13 +74,15 @@ userlandfs .......... As a second step, it's possible to use the filesystem as part of a running -system, while still running it in userland. This allows use of Debugger, +system, while still running it in userland. This allows the use of Debugger, memory protection, and in general any kind of userland debugging or tracing -tool. When the filesystem crashes, it does not bring down the whole system. +tool. Moreover, the system and kernel can survive an userland +filesystem crash, reducing the risk of corrupting data or losing +work. Userlandfs can run the filesystem code using the same interface as the kernel, therefore, once everything is working with userlandfs, running the filesystem -as kernel code is usually quite easy (and provides a performance boost) +as kernel code is usually quite easy (and provides a performance boost). See more here: :ref:`Userland FS Page`