aboutsummaryrefslogtreecommitdiff
path: root/docs/kernel/filesystem/inode.rst
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@ost.ch>2026-08-19 16:50:12 +0200
committerFelix Morgner <felix.morgner@ost.ch>2026-08-19 16:50:12 +0200
commitb7d4273f655c97974ee853082ac5dc1f69aa6324 (patch)
tree2c585f2f106919d8deb7362c42235447a7b20ece /docs/kernel/filesystem/inode.rst
parent9fe746c41ec00ddb9d0b5f31616ae3970a73bb74 (diff)
downloadkernel-b7d4273f655c97974ee853082ac5dc1f69aa6324.tar.xz
kernel-b7d4273f655c97974ee853082ac5dc1f69aa6324.zip
docs: clean up some of the documentation
Diffstat (limited to 'docs/kernel/filesystem/inode.rst')
-rw-r--r--docs/kernel/filesystem/inode.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/kernel/filesystem/inode.rst b/docs/kernel/filesystem/inode.rst
new file mode 100644
index 00000000..6e36bda1
--- /dev/null
+++ b/docs/kernel/filesystem/inode.rst
@@ -0,0 +1,12 @@
+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