From f1f1d21ab6cdf24f0f4f342b56de66c3887bf37a Mon Sep 17 00:00:00 2001 From: XeonSquared Date: Wed, 13 Sep 2017 12:36:24 +1000 Subject: [PATCH] wrote documentation on the filesystem layout --- docs/fhs.md | 18 ++++++++++++++++++ docs/index.md | 1 + 2 files changed, 19 insertions(+) create mode 100644 docs/fhs.md diff --git a/docs/fhs.md b/docs/fhs.md new file mode 100644 index 0000000..ec8c80f --- /dev/null +++ b/docs/fhs.md @@ -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. diff --git a/docs/index.md b/docs/index.md index 0a69222..7bededc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,3 +23,4 @@ PsychOS is a single-user cooperative multitasking operating system for OpenCompu - User guide (WIP) - [Building PsychOS](building.html) - [API documentation](api.html) +- [Filesystem layout](fhs.html)