aboutsummaryrefslogtreecommitdiff
path: root/src/common/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/common/README')
-rw-r--r--src/common/README9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/common/README b/src/common/README
index e40df40..7e3e1f7 100644
--- a/src/common/README
+++ b/src/common/README
@@ -1,5 +1,9 @@
This directory contains the library functions common to userland
-and kernel code.
+and kernel code, for the three basic libraries of the system :
+
+- libkogata : memory allocation, system functions
+- libc : (partial)implementation of standard libc functions
+- libalgo : usefull data structures
It relies on a few functions being exported :
@@ -14,6 +18,9 @@ These function are supposed to be defined in the code that calls
the common functions. The headers for these functions are to be
found in `assert.h` and `malloc.h`.
+In kernel code, these functions are defined somewhere in the kernel.
+In user code, these functions are defined in the user part of libkogata.
+
Panic and panic_assert end the execution of the current program
(or of the kernel when in kernel-mode).