
==========================
Soclib tools documentation
==========================

This document describes the SoCLib build tools. It covers the
following topics:

* General concepts_ about the component's :ref:`metadata <md>`,
  and the :py:mod:`underlying library <soclib_desc>`.

* Overview of the :ref:`build-system <build>` and its
  :py:mod:`implementation <soclib_builder>`.

* :ref:`soclib-cc` usage.

* User-provided file formats, like :py:mod:`.sd file format
  <sd_parser>`, :ref:`platform decsriptions <pf-def>`, and
  :ref:`configuration files <soclib.conf>`

This document neither covers components nor
platform modeling concepts.

Usage
=====

.. toctree::
   :maxdepth: 1

   soclib-cc
   configuration
   platform_desc
   sd-file/index

Concepts
========

.. toctree::
   :maxdepth: 1

   build
   metadata

API
===

.. toctree::
   :maxdepth: 1

   api/index
   api/client_howto

==================
Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

