summaryrefslogtreecommitdiff
path: root/src/kernel/mem/heap.h
diff options
context:
space:
mode:
authorAlexis211 <alexis211@gmail.com>2010-08-10 20:39:57 +0200
committerAlexis211 <alexis211@gmail.com>2010-08-10 20:39:57 +0200
commitf81bf65484fa8c81a1886f456c71f1e6eebe84e9 (patch)
tree146f304d8de8828003edd548df22cca581044017 /src/kernel/mem/heap.h
parent0ec0ca40a4fedfe97c49903a329b2a9ad2e22d03 (diff)
downloadTCE-f81bf65484fa8c81a1886f456c71f1e6eebe84e9.tar.gz
TCE-f81bf65484fa8c81a1886f456c71f1e6eebe84e9.zip
Added a lot of comments in kernel code. A bit of cleaning too.
Diffstat (limited to 'src/kernel/mem/heap.h')
-rw-r--r--src/kernel/mem/heap.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/kernel/mem/heap.h b/src/kernel/mem/heap.h
index 39ba37e..8f8cdcf 100644
--- a/src/kernel/mem/heap.h
+++ b/src/kernel/mem/heap.h
@@ -1,6 +1,11 @@
#ifndef DEF_HEAP_H
#define DEF_HEAP_H
+/* The heap is the data structure that permits allocating and freeing memory easily.
+ The functions in this file are only used by mem.c, which provides kmalloc and kfree.
+ The heap algorithm used is the one described here :
+ http://www.jamesmolloy.co.uk/tutorial_html/7.-The%20Heap.html */
+
#include "types.h"
struct heap_header {