[docs] Add sphinx documentation

Add a first pass at documentation with sphinx.
This commit is contained in:
Justin C. Miller
2024-03-07 21:48:25 -08:00
parent 40130076b2
commit 396fc131e0
15 changed files with 883 additions and 5 deletions

View File

@@ -1,3 +1,6 @@
# An ``event`` is a simple synchronization object. It contains up to 64 signals
# that threads can wait for and signal in parallel.
object event : object {
uid f441e03da5516b1a

View File

@@ -1,4 +1,6 @@
# The base type of all kernel-exposed objects
# All kernel-exposed objects inherit from the base ``object`` type, so the
# ``object`` syscalls can be used with any object's handle.
object object [virtual] {
uid 667f61fb2cd57bb4
cname kobject

View File

@@ -1,7 +1,7 @@
import "objects/object.def"
# Processes are a collection of handles and a virtual memory
# space inside which threads are run.
# A ``process`` object represents a process running on the system, and allows
# control over the threads, handles, and virtual memory space of that process.
object process : object {
uid 0c69ee0b7502ba31

View File

@@ -1,5 +1,6 @@
# The system object represents a handle to kernel functionality
# needed by drivers and other priviledged services
# The singular ``system`` object represents a handle to kernel functionality
# needed by drivers and other priviledged services.
object system : object {
uid fa72506a2cf71a30

View File

@@ -1,3 +1,7 @@
# A ``thread`` object represents a thread of execution within a process running
# on the system. The actual thread does not need to be currently running to
# hold a handle to it.
object thread : object {
uid 11f23e593d5761bd

View File

@@ -1,5 +1,9 @@
import "objects/process.def"
# A ``vma`` object represents a single virtual memory area, which may be shared
# between several processes. A process having a handle to a ``vma`` does not
# necessarily mean that it is mapped into that process' virtual memory space.
object vma : object {
uid d6a12b63b3ed3937
cname vm_area