| <!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>Using — 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="Getting started" href="using_tutorial.html" /> |
| <link rel="prev" title="Installing from Source" href="main_install.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 current"><a class="current reference internal" href="#">Using</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="using_tutorial.html">Getting started</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_developing.html">Developing</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_handling_files.html">Handling files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_junctions.html">Combining projects</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_config.html">User configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_commands.html">Commands</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_configuring_cache_server.html">Configuring Cache Servers</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_configuring_remote_execution.html">Remote Execution Servers</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_examples.html">Examples</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="main_core.html">Reference</a></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 active">Using</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/main_using.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="using"> |
| <span id="id1"></span><h1>Using<a class="headerlink" href="#using" title="Link to this heading"></a></h1> |
| <p>This section includes user facing documentation including tutorials, |
| guides and information on user preferences and configuration.</p> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="using_tutorial.html">Getting started</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="tutorial/first-project.html">1. Your first project</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="tutorial/running-commands.html">2. Running commands</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="tutorial/autotools.html">3. Using the autotools element</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="tutorial/integration-commands.html">4. Integration commands</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="tutorial/directives.html">5. Optionality and directives</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="using_developing.html">Developing</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="developing/workspaces.html">1. Workspaces</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="developing/strict-mode.html">2. Strict mode</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="using_handling_files.html">Handling files</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="handling-files/composition.html">1. Composition</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="handling-files/filtering.html">2. Filtering</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="handling-files/overlaps.html">3. Overlapping files</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="using_junctions.html">Combining projects</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="junctions/junction-elements.html">1. Junction elements</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="junctions/junction-workspaces.html">2. Workspaces and subprojects</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="junctions/junction-includes.html">3. Subproject includes</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="using_config.html">User configuration</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="using_config.html#configuration-file">Configuration file</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_config.html#working-directories">Working directories</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_config.html#cache-control">Cache control</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_config.html#scheduler-controls">Scheduler controls</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_config.html#build-controls">Build controls</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_config.html#fetch-controls">Fetch controls</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_config.html#track-controls">Track controls</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_config.html#logging-controls">Logging controls</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_config.html#remote-services">Remote services</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_config.html#project-specific-values">Project specific values</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_config.html#default-configuration">Default configuration</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="using_commands.html">Commands</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="using_commands.html#commonly-used-parameters">Commonly used parameters</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_commands.html#top-level-commands">Top-level commands</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_commands.html#artifact-subcommands">Artifact subcommands</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_commands.html#source-subcommands">Source subcommands</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_commands.html#workspace-subcommands">Workspace subcommands</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="using_configuring_cache_server.html">Configuring Cache Servers</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="using_configuring_cache_server.html#setting-up-a-remote-cache">Setting up a remote cache</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_configuring_cache_server.html#known-implementations">Known implementations</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="using_configuring_remote_execution.html">Remote Execution Servers</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="using_configuring_remote_execution.html#buildstream-specific-requirements">BuildStream specific requirements</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="using_configuring_remote_execution.html#example-working-configuration">Example working configuration</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="using_examples.html">Examples</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="examples/tar-mirror.html">Creating and using a tar mirror</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="examples/git-mirror.html">Creating and using a git mirror</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="main_install.html" class="btn btn-neutral float-left" title="Installing from Source" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="using_tutorial.html" class="btn btn-neutral float-right" title="Getting started" 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> |
