| <!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>Managing data files — 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="Updating BuildStream’s Python dependencies" href="updating_python_deps.html" /> |
| <link rel="prev" title="Generating protocol buffers" href="grpc_protocols.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"><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 current"><a class="reference internal" href="../CONTRIBUTING.html">Contributing</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../CONTRIBUTING.html#filing-issues">Filing issues</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../CONTRIBUTING.html#fixing-bugs">Fixing bugs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../CONTRIBUTING.html#adding-new-features">Adding new features</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../CONTRIBUTING.html#submitting-patches">Submitting patches</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../CONTRIBUTING.html#committer-access">Committer access</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../CONTRIBUTING.html#windows-ci">Windows CI</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="../CONTRIBUTING.html#further-information">Further information</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="coding_guidelines.html">Coding guidelines</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="using_the_testsuite.html">Using the test suite</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="writing_documentation.html">Writing documentation</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="writing_plugins.html">Adding core plugins</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="measuring_performance.html">Measuring performance</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="making_releases.html">Making releases</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="grpc_protocols.html">Generating protocol buffers</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">Managing data files</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="updating_python_deps.html">Updating BuildStream’s Python dependencies</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="updating_python_deps.html#adding-support-for-a-new-python-release">Adding support for a new Python release</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="updating_python_deps.html#removing-support-for-a-python-release">Removing support for a Python release</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="updating_python_deps.html#abi-compatibility-for-binary-python-packages">ABI compatibility for binary Python packages</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="ui.html">Contributing to the UI</a></li> |
| </ul> |
| </li> |
| </ul> |
| </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="../CONTRIBUTING.html">Contributing</a></li> |
| <li class="breadcrumb-item active">Managing data files</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="../_sources/hacking/managing_data_files.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="managing-data-files"> |
| <span id="id1"></span><h1>Managing data files<a class="headerlink" href="#managing-data-files" title="Link to this heading"></a></h1> |
| <p>When adding data files which need to be discovered at runtime by BuildStream, update setup.py accordingly.</p> |
| <p>When adding data files for the purpose of docs or tests, or anything that is not covered by |
| setup.py, update the MANIFEST.in accordingly.</p> |
| <p>At any time, running the following command to create a source distribution should result in |
| creating a tarball which contains everything we want it to include:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">sdist</span> |
| </pre></div> |
| </div> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="grpc_protocols.html" class="btn btn-neutral float-left" title="Generating protocol buffers" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="updating_python_deps.html" class="btn btn-neutral float-right" title="Updating BuildStream’s Python dependencies" 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> |
