CINXE.COM
BuildStream documentation — BuildStream documentation
<!DOCTYPE html> <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>BuildStream documentation — BuildStream documentation</title> <script type="text/javascript" src="_static/js/modernizr.min.js"></script> <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/language_data.js"></script> <script type="text/javascript" src="_static/js/theme.js"></script> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="genindex.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="#" class="icon icon-home">BuildStream</a> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="#">BuildStream</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <div class="section" id="buildstream-documentation"> <h1>BuildStream documentation<a class="headerlink" href="#buildstream-documentation" title="Permalink to this headline">露</a></h1> <div class="section" id="versions"> <a class="reference internal image-reference" href="master/_static/release.html"><img alt="master/_static/release.svg" src="master/_static/release.svg" /></a> <p>There are two major versions of BuildStream currently supported.</p> <p> <b>Apache BuildStream 2</b> is the latest stable version. We recommend that all new projects use Apache BuildStream 2. </p> <p> <b>BuildStream 1</b> is the "classic taste" version, stable and supported since 2018. No new feature development is planned for BuildStream 1. </p> <p> If you want to build a specific project, check its <tt>project.conf</tt> file for the <a href="master/format_project.html#minimum-version"><tt>min-version</tt></a>. If the setting is <tt>2.0</tt> or above you need BuildStream 2, if the setting is not present then you need BuildStream 1. </p> <p> Note that a <a href="master/main_porting.html">porting guide</a> is available to help you migrate projects from BuildStream 1 to BuildStream 2. </p> <div style="display: inline-flex;"> <div style="margin-right: 50px;"> <p><b>BuildStream 1 documentation:</b></p> <ul> <li class="toctree-l1"><a class="reference internal" href="1.6/index.html">1.6.9</a></li> <li class="toctree-l1"><a class="reference internal" href="1.4/index.html">1.4.3</a></li> <li class="toctree-l1"><a class="reference internal" href="1.2/index.html">1.2.8</a></li> <li class="toctree-l1"><a class="reference internal" href="1.0/index.html">1.0.1</a></li> </ul> </div> <div> <p><b>BuildStream 2 documentation:</b></p> <ul> <li class="toctree-l1"><a class="reference internal" href="2.4/index.html">2.4.1</a></li> <li class="toctree-l1"><a class="reference internal" href="2.3/index.html">2.3.0</a></li> <li class="toctree-l1"><a class="reference internal" href="2.1/index.html">2.1.0</a></li> <li class="toctree-l1"><a class="reference internal" href="2.0/index.html">2.0.1</a></li> </ul> </div> </div> <div> <p> You can also browse documentation for future unreleased versions from the master branch <a class="reference internal" href="master/index.html">here</a>. </p> </div> </div> </div> </div> </div> <footer> <hr/> <div role="contentinfo"> <p>© Copyright 2017-2023, The Apache Software Foundation</p> </div> Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>