diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-03-16 16:42:16 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-03-16 16:42:16 +0900 |
| commit | 674837b0ac356b67fb94fa3f739701f5dabe8d42 (patch) | |
| tree | 92b5670be8bc87c95076796a9bd54a124f8042e9 /doc/source/index.rst | |
| parent | 2fe7d48c07552aaaec038a1d6818edb7168d23cb (diff) | |
| download | buildstream-674837b0ac356b67fb94fa3f739701f5dabe8d42.tar.gz | |
Documentation index: Started categorizing elements
Split up General Elements from Build Elements
Diffstat (limited to 'doc/source/index.rst')
| -rw-r--r-- | doc/source/index.rst | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index c2f8d2270..1be66fb58 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -23,7 +23,7 @@ elements for doing more elaborate things such as deploying software in special w Using BuildStream ------------------ +================= Here are some resources to help you get off the ground when creating your very first BuildStream project. @@ -31,12 +31,19 @@ first BuildStream project. Elements -~~~~~~~~ -The following element types are provided with BuildStream: +-------- + + +General Elements +~~~~~~~~~~~~~~~~ * :mod:`stack` - Symbolic Element for dependency grouping * :mod:`import` - Import sources directly * :mod:`compose` - Compose the output of multiple elements + +Build Elements +~~~~~~~~~~~~~~ + * :mod:`manual` - Manual Build Element * :mod:`autotools` - Autotools Build Element * :mod:`cmake` - CMake Build Element @@ -46,8 +53,9 @@ The following element types are provided with BuildStream: * :mod:`modulebuild` - Perl Module::Build Build Element * :mod:`meson` - Meson Build Element + Sources -~~~~~~~ +-------- The following source types are provided with BuildStream: * :mod:`local` - A Source implementation local files and directories |