summaryrefslogtreecommitdiff
path: root/libdde-linux26/README
diff options
context:
space:
mode:
authorSamuel Thibault <samuel.thibault@ens-lyon.org>2013-07-27 22:15:01 +0000
committerSamuel Thibault <samuel.thibault@ens-lyon.org>2013-07-27 22:15:01 +0000
commit7996a3d79d55b7f879dfd62e202bbfe2963718d3 (patch)
tree8d9f6759fec4099b9be503c11c7ed174f7204980 /libdde-linux26/README
parent4fbe7358c7747a9165f776eb19addbb9baf7def2 (diff)
really properly move files
Diffstat (limited to 'libdde-linux26/README')
-rw-r--r--libdde-linux26/README46
1 files changed, 46 insertions, 0 deletions
diff --git a/libdde-linux26/README b/libdde-linux26/README
new file mode 100644
index 00000000..ccc58959
--- /dev/null
+++ b/libdde-linux26/README
@@ -0,0 +1,46 @@
+ This is DDELinux 2.6.29
+
+Directory structure
+###################
+
+'contrib/'
+==========
+
+This directory tree holds unmodified Linux sources. The files residing here
+are sourced by Makefiles in 'examples' and 'lib'. All unmodified C headers are
+also kept here.
+
+
+'include/'
+==========
+
+Currently reimplemented and modified C headers as well as the DDELinux 2.6 API
+definition are kept in this directory tree.
+
+Include stuff works as following. First, we install all Linux headers from
+contrib/include to the build directory. Thereafter, we pull in our
+modifications by installing all header files from include/ to the appropriate
+include paths, thereby overwriting the original versions.
+
+
+'lib/src/arch/l4'
+=================
+
+Contains reimplementations of Linux functions that are implemented differently
+in our environment or that are mapped to DDEKit calls. There are no Linux
+functions included here.
+
+
+'lib/src/<linux subdir name>'
+=============================
+
+When we import functions from Linux instead of reimplementing them, we copy
+the whole Linux source file containing this function to this location. We then
+modify the file according to our needs, mostly by wrapping unneeded parts with
+'#ifndef DDE_LINUX .. #endif' blocks.
+
+
+'examples/'
+==========
+
+Here reside test code and example drivers.