| <!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>Plugin specific documentation — 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="stack - Symbolic Element for dependency grouping" href="elements/stack.html" /> |
| <link rel="prev" title="The project.refs file" href="format_project_refs.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"><a class="reference internal" href="core_format.html">Project format</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">Plugin specific documentation</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#elements">Elements</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="elements/stack.html">stack - Symbolic Element for dependency grouping</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="elements/import.html">import - Import sources directly</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="elements/compose.html">compose - Compose the output of multiple elements</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="elements/script.html">script - Run scripts to create output</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="elements/link.html">link - Link elements</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="elements/junction.html">junction - Integrate subprojects</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="elements/filter.html">filter - Extract a subset of files from another element</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="elements/manual.html">manual - Manual build element</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#sources">Sources</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="sources/local.html">local - stage local files and directories</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="sources/remote.html">remote - stage files from remote urls</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="sources/tar.html">tar - stage files from tar archives</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="#external-plugins">External plugins</a></li> |
| </ul> |
| </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">Plugin specific documentation</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/core_plugins.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="plugin-specific-documentation"> |
| <span id="plugins"></span><h1>Plugin specific documentation<a class="headerlink" href="#plugin-specific-documentation" title="Link to this heading"></a></h1> |
| <p>Plugins provide their own individual plugin specific YAML configurations, |
| The element <code class="docutils literal notranslate"><span class="pre">.bst</span></code> files can specify plugin specific configuration in |
| the <a class="reference internal" href="format_declaring.html#format-config"><span class="std std-ref">config section</span></a>, while sources declared on a |
| given element specify their plugin specific configuration directly |
| <a class="reference internal" href="format_declaring.html#format-sources"><span class="std std-ref">in their source declarations</span></a>.</p> |
| <section id="elements"> |
| <span id="plugins-elements"></span><h2>Elements<a class="headerlink" href="#elements" title="Link to this heading"></a></h2> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="elements/stack.html">stack - Symbolic Element for dependency grouping</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="elements/import.html">import - Import sources directly</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="elements/compose.html">compose - Compose the output of multiple elements</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="elements/script.html">script - Run scripts to create output</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="elements/link.html">link - Link elements</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="elements/junction.html">junction - Integrate subprojects</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="elements/filter.html">filter - Extract a subset of files from another element</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="elements/manual.html">manual - Manual build element</a></li> |
| </ul> |
| </div> |
| </section> |
| <section id="sources"> |
| <span id="plugins-sources"></span><h2>Sources<a class="headerlink" href="#sources" title="Link to this heading"></a></h2> |
| <p>All source plugins can be staged into an arbitrary directory within the build |
| sandbox with the <code class="docutils literal notranslate"><span class="pre">directory</span></code> option. |
| See <a class="reference internal" href="buildstream.source.html#core-source-builtins"><span class="std std-ref">Source class built-in functionality</span></a> for more |
| information.</p> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="sources/local.html">local - stage local files and directories</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="sources/remote.html">remote - stage files from remote urls</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="sources/tar.html">tar - stage files from tar archives</a></li> |
| </ul> |
| </div> |
| </section> |
| <section id="external-plugins"> |
| <span id="plugins-external"></span><h2>External plugins<a class="headerlink" href="#external-plugins" title="Link to this heading"></a></h2> |
| <p>External plugins need to be <a class="reference internal" href="format_project.html#project-plugins-junction"><span class="std std-ref">loading through junctions</span></a>, |
| or alternatively installed separately in the python environment where you are |
| running BuildStream and loaded using the <a class="reference internal" href="format_project.html#project-plugins-pip"><span class="std std-ref">pip method</span></a>.</p> |
| <p>Here is a list of BuildStream plugin projects known to us at this time:</p> |
| <ul class="simple"> |
| <li><p><a class="reference external" href="https://github.com/apache/buildstream-plugins/">buildstream-plugins</a></p></li> |
| <li><p><a class="reference external" href="http://buildstream.gitlab.io/bst-plugins-experimental/">bst-plugins-experimental</a></p></li> |
| <li><p><a class="reference external" href="https://pypi.org/project/bst-plugins-container/">bst-plugins-container</a></p></li> |
| </ul> |
| </section> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="format_project_refs.html" class="btn btn-neutral float-left" title="The project.refs file" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="elements/stack.html" class="btn btn-neutral float-right" title="stack - Symbolic Element for dependency grouping" 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> |
