2.1.2 The source code hierarchy

The top-level directory contains:

Build

Where the whole thing is built.

CVS

Used for the version control system.

GNUmakefile

The makefile which governs compilation.

HTML

Where the HTML version of the code is kept.

NOTES

A change-log file.

TODO

The list of things to be done.

dmm

The code for the DMM system server.

hw

The code for hardware resource containers.

node

The code for the node system server.

prtl

The code for the portal system server.

shtl

The code for the shuttle system server.

klib

The code for generic code used through the kernel. This includes abstract classes and small utilities.

include

A directory which should be included to compile C++ source files.

Each directory contains these directories:

Build

A directory to keep object and temporary files.

CVS

Used for the version control system.

Framework

This is the place where the source literate code is kept.

Src

The C++ code generated automatically from the literate source code (not containing any interface headers nor machine dependent code).

Interface

Headers exported to other system servers.

MachDep

Machine dependent code (for Intel's x86 architectures only, as of today).

The top-level include directory has:

• links to Interface directories so that a single ``-I<topdir>/include'' option is needed when compiling C++ code.
• A flux link to the OSKit include directory, for the same purpose.
• links to the minimal kernel C library header files.