aboutsummaryrefslogtreecommitdiff
path: root/src/common/README
diff options
context:
space:
mode:
authorAlex Auvolat <alex.auvolat@ens.fr>2015-02-13 20:28:54 +0100
committerAlex Auvolat <alex.auvolat@ens.fr>2015-02-13 20:28:54 +0100
commitcf0b8a52287ee7c747b1d5a7d77abdef1fb46f94 (patch)
treed06ada519003a0794d3107fea1e882b737b5a00c /src/common/README
parente484c92ff08e54e7cbfdb815a5b254507dade003 (diff)
downloadkogata-cf0b8a52287ee7c747b1d5a7d77abdef1fb46f94.tar.gz
kogata-cf0b8a52287ee7c747b1d5a7d77abdef1fb46f94.zip
Reorganize code in preparation for user apps.
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).