aboutsummaryrefslogtreecommitdiff
path: root/docs/kernel
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@ost.ch>2026-08-31 13:13:16 +0200
committerFelix Morgner <felix.morgner@ost.ch>2026-08-31 13:13:16 +0200
commitfd15eda1cf574d667fb04ebd2b51462ee8e7774e (patch)
tree02568b23e9e9f5d138d4576bc19033f6e0a1ae5b /docs/kernel
parentecf882dad2aaa6160e6c27277dceae935658b4cb (diff)
downloadkernel-fd15eda1cf574d667fb04ebd2b51462ee8e7774e.tar.xz
kernel-fd15eda1cf574d667fb04ebd2b51462ee8e7774e.zip
docs: prepare for pages deployment
Diffstat (limited to 'docs/kernel')
-rw-r--r--docs/kernel/filesystem.rst14
-rw-r--r--docs/kernel/filesystem/constants.rst10
-rw-r--r--docs/kernel/filesystem/dentry.rst12
-rw-r--r--docs/kernel/filesystem/device_inode.rst19
-rw-r--r--docs/kernel/filesystem/inode.rst12
5 files changed, 0 insertions, 67 deletions
diff --git a/docs/kernel/filesystem.rst b/docs/kernel/filesystem.rst
deleted file mode 100644
index 35d92fdc..00000000
--- a/docs/kernel/filesystem.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-Filesystem Layer
-=================
-
-The filesystem layer of the TeachOS kernel comprises all platform-agnostic filesystem entities and operations.
-All platform-independent code related to filesystem implementations resides here.
-This includes the implementations of platform-independent kAPI filesystem types and functions.
-
-.. toctree::
- :maxdepth: 1
- :caption: Contents:
- :glob:
-
- filesystem/*
-
diff --git a/docs/kernel/filesystem/constants.rst b/docs/kernel/filesystem/constants.rst
deleted file mode 100644
index aa698711..00000000
--- a/docs/kernel/filesystem/constants.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-Global Constants
-================
-
-The constants described here are applicable to all types and functions in the kernel filesystem layers.
-They describe maxima of supported lengths and sizes where not other specification takes precedence.
-
-API Reference
--------------
-
-.. doxygennamespace:: kernel::filesystem::constants
diff --git a/docs/kernel/filesystem/dentry.rst b/docs/kernel/filesystem/dentry.rst
deleted file mode 100644
index 3d40c067..00000000
--- a/docs/kernel/filesystem/dentry.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-Directory Entries
-=================
-
-A directory entry associates a name with an inode.
-As such, a directory entry may refer to any entity represented by an inode.
-Directory entries may be nested.
-
-API Reference
--------------
-
-.. doxygenstruct:: kernel::filesystem::dentry
- :members: \ No newline at end of file
diff --git a/docs/kernel/filesystem/device_inode.rst b/docs/kernel/filesystem/device_inode.rst
deleted file mode 100644
index cf5e72fa..00000000
--- a/docs/kernel/filesystem/device_inode.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-Device Inodes
-=============
-
-Device inodes are filesystem inodes that represent a device in the system.
-They may be created from either a device, or by reconstituting a persistent device inode from a filesystem.
-
-An example for device inodes created to directly represent devices are the entries in the devfs (/dev) filesystem.
-Entries in this filesystem are generally created and removed based on devices appearing in and being removed from the system.
-
-An example for device inodes reconstituted from persisted inodes can be found in the inodes supported by the ext2 filesystem.
-In that filesystem, an inode may represent a device, using a device identification number.
-When accessing such an inode, a device inode needs to be reconstituted from the persisted device inode in order to resolve which device, if any, it refers to.
-However, any file operations (e.g. `stat`) need to be forwarded to the persisted inode.
-
-API Reference
--------------
-
-.. doxygenstruct:: kernel::filesystem::device_inode
- :members: \ No newline at end of file
diff --git a/docs/kernel/filesystem/inode.rst b/docs/kernel/filesystem/inode.rst
deleted file mode 100644
index 6e36bda1..00000000
--- a/docs/kernel/filesystem/inode.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-Inode Base Class
-=================
-
-An inode (or filesystem index node) represents a filesystem entity, e.g. a file or directory, in the virtual filesystem (VFS).
-While not all filesystems may use traditional inodes, as for example used in ext2, the VFS expects for all entities to be represented as inodes.
-As such, file I/O operation always happen through inodes.
-
-API Reference
--------------
-
-.. doxygenstruct:: kernel::filesystem::inode
- :members: \ No newline at end of file