diff options
| author | Alejandro Sior <aho@sior.be> | 2022-07-29 11:45:41 +0200 |
|---|---|---|
| committer | Alejandro Sior <aho@sior.be> | 2022-07-29 11:45:41 +0200 |
| commit | 722375d20a699e935437100be3f87c2fbe710886 (patch) | |
| tree | 9265e4b1667afc16aab9cda03f6377ba8857d6e0 /docs | |
| parent | aab012d713e801891aa11b6654bb9128da89d20f (diff) | |
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man.7.scd | 3 | ||||
| -rw-r--r-- | docs/verbs.7.scd | 6 |
2 files changed, 8 insertions, 1 deletions
diff --git a/docs/man.7.scd b/docs/man.7.scd index a705d90..20e10a2 100644 --- a/docs/man.7.scd +++ b/docs/man.7.scd @@ -10,11 +10,12 @@ The operating system aims to be self documenting. As such a manual is written de # SECTIONS - +``` 1. Utilities 3. Libraries 7. Miscellaneous 9. Kernel internals +``` # TODO diff --git a/docs/verbs.7.scd b/docs/verbs.7.scd index 1598342..b529293 100644 --- a/docs/verbs.7.scd +++ b/docs/verbs.7.scd @@ -14,7 +14,9 @@ The *init* verb initializes a structure; that is, upon success, it puts the obje The initialization function has the following signature: +``` [int] x_init(X*, ...) +``` where the return value can be used to communicate errors. See relevant documentation for implementation's meanings. @@ -26,7 +28,9 @@ The *drop* verb is the opposite of the init verb: it puts the object in a state The drop operation has the following signature: +``` [int] x_drop(X*, ...) +``` ## Install @@ -34,6 +38,8 @@ The *install* verb places and initializes an object at a specified location *add The install operation has the following signature: +``` X *x_install(void *addr, ...) +``` A notable example of a structure that gets to be installed is the MemFramer (mem/framer.h). This frame allocator is notably used for managing physical memory. Since it can be used at times when heap allocation is not yet available, the structure can be installed at the beginning of free regions.
\ No newline at end of file |