| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>Project format — BuildStream 2.2.0+3.gc7274d41d documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" /> |
| |
| |
| <!--[if lt IE 9]> |
| <script src="_static/js/html5shiv.min.js"></script> |
| <![endif]--> |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=f96d84dc"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="Introduction" href="format_intro.html" /> |
| <link rel="prev" title="Reference" href="main_core.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> |
| BuildStream |
| </a> |
| <div class="version"> |
| 2.2.0+3.gc7274d41d |
| </div> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="main_about.html">About</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="main_install.html">Installing from Source</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="main_using.html">Using</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="main_core.html">Reference</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">Project format</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="format_intro.html">Introduction</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="format_project.html">Project configuration</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="format_declaring.html">Declaring elements</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="format_public.html">Builtin public data</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="format_project_refs.html">The project.refs file</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="core_plugins.html">Plugin specific documentation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="core_framework.html">Plugin API reference</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="core_additional.html">Additional writings</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="buildstream.html">buildstream package</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="main_porting.html">Porting guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="CONTRIBUTING.html">Contributing</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="main_architecture.html">Architecture</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="main_glossary.html">Glossary</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">BuildStream</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="main_core.html">Reference</a></li> |
| <li class="breadcrumb-item active">Project format</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/core_format.rst.txt" rel="nofollow"> View page source</a> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <section id="project-format"> |
| <h1>Project format<a class="headerlink" href="#project-format" title="Link to this heading"></a></h1> |
| <p>This section details how to use the BuildStream YAML format to |
| create your own project or modify existing projects.</p> |
| <div class="toctree-wrapper compound"> |
| <p class="caption" role="heading"><span class="caption-text">Project format</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="format_intro.html">Introduction</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="format_intro.html#directory-structure">Directory structure</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_intro.html#composition">Composition</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_intro.html#directives">Directives</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="format_project.html">Project configuration</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="format_project.html#essentials">Essentials</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_project.html#loading-plugins">Loading plugins</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_project.html#options">Options</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_project.html#junctions">Junctions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_project.html#element-default-configuration">Element default configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_project.html#overriding-plugin-defaults">Overriding plugin defaults</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_project.html#customizing-the-shell">Customizing the shell</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_project.html#default-targets">Default targets</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_project.html#builtin-defaults">Builtin defaults</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="format_declaring.html">Declaring elements</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="format_declaring.html#element-basics">Element basics</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_declaring.html#dependencies">Dependencies</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_declaring.html#using-variables">Using variables</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="format_public.html">Builtin public data</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="format_public.html#integration-commands">Integration commands</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_public.html#split-rules">Split rules</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_public.html#overlap-whitelist">Overlap whitelist</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="format_project_refs.html">The project.refs file</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="format_project_refs.html#basic-behavior">Basic behavior</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="format_project_refs.html#format">Format</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="main_core.html" class="btn btn-neutral float-left" title="Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="format_intro.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2017-2022, The Apache Software Foundation.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
