wrote documentation on the filesystem layout

This commit is contained in:
Izaya 2017-09-13 12:36:24 +10:00
parent 5557cd4d41
commit f1f1d21ab6
2 changed files with 19 additions and 0 deletions

18
docs/fhs.md Normal file
View File

@ -0,0 +1,18 @@
## Filesystem Hierarchy Standard
PsychOS is not a UNIX system, nor does it try to be. It doesn't have a 'real' VFS and doesn't have a devfs. As such, the filesystem is arranged differently.
### Top level filesystems.
Filesystems devices are represented as top-level directories, eg /boot, /tmp, /fs01.
The mount points are strings, and can be of arbitrary length. However, it is recommended to keep them under 20 characters, and to not have spaces, or special characters in them.
A device can be mounted multiple times under multiple names.
### /boot
/boot is the device the system booted from, and may be the same as /tmp under some circumstances. It contains all the special directories needed for the system to function.
#### /boot/exec
exec contains executable programs and utilities, generally separate from the kernel.
#### /boot/lib
lib contains all the libraries used by the system.
#### /boot/doc
doc contains the documentation, though it may not exist if the documentation isn't neccesary.
#### /boot/sys
sys contains miscellaneous system files like the user database and autorun scripts.

View File

@ -23,3 +23,4 @@ PsychOS is a single-user cooperative multitasking operating system for OpenCompu
- User guide (WIP) - User guide (WIP)
- [Building PsychOS](building.html) - [Building PsychOS](building.html)
- [API documentation](api.html) - [API documentation](api.html)
- [Filesystem layout](fhs.html)