zephyr/doc/kernel/overview/source_tree.rst
Anas Nashif 1ab2d24c1a docs: Update information about tree structure
add boards, tests sub-directories to the tree.

Change-Id: I353fd4a4b2b23f7d3a7ca22d42b555ffb1b14ce5
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-14 18:40:35 -05:00

53 lines
1.4 KiB
ReStructuredText

.. _source_tree:
Source Tree Structure
#####################
The Zephyr source tree provides the following top-level directories,
each of which may have one or more additional levels of subdirectories
which are not described here.
:file:`arch`
Architecture-specific nanokernel and platform code. Each supported
architecture has its own subdirectory, which contains additional
subdirectories for the following areas:
* architecture-specific nanokernel source files
* architecture-specific nanokernel include files for private APIs
* platform-specific code
:file:`boards`
Board related code and configuration files.
:file:`doc`
Zephyr documentation-related material and tools.
:file:`drivers`
Device driver code.
:file:`include`
Include files for all public APIs, except those defined under :file:`lib`.
:file:`kernel`
Microkernel code, and architecture-independent nanokernel code.
:file:`lib`
Library code, including the minimal standard C library.
:file:`misc`
Miscellaneous code.
:file:`net`
Networking code, including the Bluetooth stack and networking stacks.
:file:`samples`
Sample applications for the microkernel, nanokernel, Bluetooth stack,
and networking stacks.
:file:`tests`
Test code and benchmarks for the various kernel features.
:file:`scripts`
Various programs and other files used to build and test Zephyr
applications.