diff options
| author |   Ulrich Müller <ulm@gentoo.org> | 2023-01-14 18:21:24 +0100 |
|---|---|---|
| committer | Ulrich Müller <ulm@gentoo.org> | 2023-01-14 18:21:24 +0100 |
| commit | a3212d8ef9f80ba6944d8f29b9ad3650f6c93c49 (patch) | |
| tree | c6d590e7674b6ec54c957398c1a276f88a6c2b3d /ebuild-format.html | |
| parent | Remove Google+ from footer (diff) | |
| download | policy-guide-a3212d8ef9f80ba6944d8f29b9ad3650f6c93c49.tar.gz policy-guide-a3212d8ef9f80ba6944d8f29b9ad3650f6c93c49.tar.bz2 policy-guide-a3212d8ef9f80ba6944d8f29b9ad3650f6c93c49.zip | |
Rebuild
Manually fix the copyright line.
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
Diffstat (limited to 'ebuild-format.html')
| -rw-r--r-- | ebuild-format.html | 86 |
1 files changed, 54 insertions, 32 deletions
diff --git a/ebuild-format.html b/ebuild-format.html index 946c42d..2c9f1ee 100644 --- a/ebuild-format.html +++ b/ebuild-format.html @@ -1,11 +1,11 @@ <!doctype html> -<html xmlns="http://www.w3.org/1999/xhtml"> +<html xmlns="http://www.w3.org/1999/xhtml" lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> - <meta name="viewport" content="width=device-width, initial-scale=1"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + <meta name="viewport" content="width=device-width, initial-scale=1"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> <title>Ebuild file format — Gentoo Policy Guide documentation</title> <link rel="stylesheet" href="_static/tyrian-sphinx-theme.css" type="text/css" /> @@ -19,9 +19,8 @@ <link rel="stylesheet" type="text/css" href="_static/tyrian-sphinx-theme.css" /> <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> - <script src="_static/jquery.js"></script> - <script src="_static/underscore.js"></script> <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="File system layout" href="filesystem.html" /> @@ -134,17 +133,17 @@ <section id="ebuild-file-format"> -<h1>Ebuild file format<a class="headerlink" href="#ebuild-file-format" title="Permalink to this headline">¶</a></h1> +<h1>Ebuild file format<a class="headerlink" href="#ebuild-file-format" title="Permalink to this heading">¶</a></h1> <section id="pg0101"> -<span id="coding-style"></span><span id="index-0"></span><h2>Coding style<a class="headerlink" href="#pg0101" title="Permalink to this headline">¶</a></h2> +<span id="coding-style"></span><span id="index-0"></span><h2>Coding style<a class="headerlink" href="#pg0101" title="Permalink to this heading">¶</a></h2> <dl class="field-list simple"> -<dt class="field-odd">PG</dt> +<dt class="field-odd">PG<span class="colon">:</span></dt> <dd class="field-odd"><p>0101</p> </dd> -<dt class="field-even">Source</dt> +<dt class="field-even">Source<span class="colon">:</span></dt> <dd class="field-even"><p>QA</p> </dd> -<dt class="field-odd">Reported</dt> +<dt class="field-odd">Reported<span class="colon">:</span></dt> <dd class="field-odd"><p>partially via repoman and pkgcheck</p> </dd> </dl> @@ -163,18 +162,18 @@ Consistency avoids unnecessary changes when other developers edit the ebuild.</p> </section> <section id="pg0102"> -<span id="code-must-be-contained-within-ebuild-and-eclasses"></span><span id="index-1"></span><h2>Code must be contained within ebuild and eclasses<a class="headerlink" href="#pg0102" title="Permalink to this headline">¶</a></h2> +<span id="code-must-be-contained-within-ebuild-and-eclasses"></span><span id="index-1"></span><h2>Code must be contained within ebuild and eclasses<a class="headerlink" href="#pg0102" title="Permalink to this heading">¶</a></h2> <dl class="field-list simple"> -<dt class="field-odd">PG</dt> +<dt class="field-odd">PG<span class="colon">:</span></dt> <dd class="field-odd"><p>0102</p> </dd> -<dt class="field-even">Source</dt> +<dt class="field-even">Source<span class="colon">:</span></dt> <dd class="field-even"><p>QA</p> </dd> -<dt class="field-odd">Reference</dt> +<dt class="field-odd">Reference<span class="colon">:</span></dt> <dd class="field-odd"><p><a class="reference external" href="https://bugs.gentoo.org/612630">https://bugs.gentoo.org/612630</a></p> </dd> -<dt class="field-even">Reported</dt> +<dt class="field-even">Reported<span class="colon">:</span></dt> <dd class="field-even"><p>no</p> </dd> </dl> @@ -190,15 +189,15 @@ confuses other developers and tools that do not explicitly account for that possibility, including linting tools.</p> </section> <section id="pg0103"> -<span id="homepage-must-not-contain-variables"></span><span id="index-2"></span><h2>HOMEPAGE must not contain variables<a class="headerlink" href="#pg0103" title="Permalink to this headline">¶</a></h2> +<span id="homepage-must-not-contain-variables"></span><span id="index-2"></span><h2>HOMEPAGE must not contain variables<a class="headerlink" href="#pg0103" title="Permalink to this heading">¶</a></h2> <dl class="field-list simple"> -<dt class="field-odd">PG</dt> +<dt class="field-odd">PG<span class="colon">:</span></dt> <dd class="field-odd"><p>0103</p> </dd> -<dt class="field-even">Source</dt> +<dt class="field-even">Source<span class="colon">:</span></dt> <dd class="field-even"><p>QA</p> </dd> -<dt class="field-odd">Reported</dt> +<dt class="field-odd">Reported<span class="colon">:</span></dt> <dd class="field-odd"><p>by pkgcheck, highlighted as error by gentoo-syntax</p> </dd> </dl> @@ -212,15 +211,15 @@ preprocessing, breaking URI support in terminals and editors, as well as reducing the usefulness of plain tools such as grep.</p> </section> <section id="pg0104"> -<span id="src-uri-must-not-refer-to-homepage"></span><span id="index-3"></span><h2>SRC_URI must not refer to HOMEPAGE<a class="headerlink" href="#pg0104" title="Permalink to this headline">¶</a></h2> +<span id="src-uri-must-not-refer-to-homepage"></span><span id="index-3"></span><h2>SRC_URI must not refer to HOMEPAGE<a class="headerlink" href="#pg0104" title="Permalink to this heading">¶</a></h2> <dl class="field-list simple"> -<dt class="field-odd">PG</dt> +<dt class="field-odd">PG<span class="colon">:</span></dt> <dd class="field-odd"><p>0104</p> </dd> -<dt class="field-even">Source</dt> +<dt class="field-even">Source<span class="colon">:</span></dt> <dd class="field-even"><p>QA</p> </dd> -<dt class="field-odd">Reported</dt> +<dt class="field-odd">Reported<span class="colon">:</span></dt> <dd class="field-odd"><p>by pkgcheck</p> </dd> </dl> @@ -235,15 +234,15 @@ it hard to copy-paste part of the URI e.g. to investigate the directory index.</p> </section> <section id="pg0105"> -<span id="keywords-must-be-defined-on-a-single-line"></span><span id="index-4"></span><h2>KEYWORDS must be defined on a single line<a class="headerlink" href="#pg0105" title="Permalink to this headline">¶</a></h2> +<span id="keywords-must-be-defined-on-a-single-line"></span><span id="index-4"></span><h2>KEYWORDS must be defined on a single line<a class="headerlink" href="#pg0105" title="Permalink to this heading">¶</a></h2> <dl class="field-list simple"> -<dt class="field-odd">PG</dt> +<dt class="field-odd">PG<span class="colon">:</span></dt> <dd class="field-odd"><p>0105</p> </dd> -<dt class="field-even">Source</dt> +<dt class="field-even">Source<span class="colon">:</span></dt> <dd class="field-even"><p>QA</p> </dd> -<dt class="field-odd">Reported</dt> +<dt class="field-odd">Reported<span class="colon">:</span></dt> <dd class="field-odd"><p>no</p> </dd> </dl> @@ -256,15 +255,15 @@ ability to process and modify ebuilds, and therefore developers must make sure that it works correctly on their ebuilds.</p> </section> <section id="pg0106"> -<span id="license-must-not-contain-variables"></span><span id="index-5"></span><h2>LICENSE must not contain variables<a class="headerlink" href="#pg0106" title="Permalink to this headline">¶</a></h2> +<span id="license-must-not-contain-variables"></span><span id="index-5"></span><h2>LICENSE must not contain variables<a class="headerlink" href="#pg0106" title="Permalink to this heading">¶</a></h2> <dl class="field-list simple"> -<dt class="field-odd">PG</dt> +<dt class="field-odd">PG<span class="colon">:</span></dt> <dd class="field-odd"><p>0106</p> </dd> -<dt class="field-even">Source</dt> +<dt class="field-even">Source<span class="colon">:</span></dt> <dd class="field-even"><p>QA</p> </dd> -<dt class="field-odd">Reported</dt> +<dt class="field-odd">Reported<span class="colon">:</span></dt> <dd class="field-odd"><p>no</p> </dd> </dl> @@ -276,6 +275,27 @@ allowed.</p> package versions), using variables there has little advantage. On the other hand, variables reduce the usefulness of plain tools such as grep.</p> </section> +<section id="pg0107"> +<span id="d-must-be-used-only-in-src-install-and-pkg-preinst"></span><span id="index-6"></span><h2>D must be used only in src_install and pkg_preinst<a class="headerlink" href="#pg0107" title="Permalink to this heading">¶</a></h2> +<dl class="field-list simple"> +<dt class="field-odd">PG<span class="colon">:</span></dt> +<dd class="field-odd"><p>0107</p> +</dd> +<dt class="field-even">Source<span class="colon">:</span></dt> +<dd class="field-even"><p>QA</p> +</dd> +<dt class="field-odd">Reported<span class="colon">:</span></dt> +<dd class="field-odd"><p>no</p> +</dd> +</dl> +<p>The <code class="docutils literal notranslate"><span class="pre">D</span></code> and <code class="docutils literal notranslate"><span class="pre">ED</span></code> variables must be used only in the <code class="docutils literal notranslate"><span class="pre">src_install</span></code> +and <code class="docutils literal notranslate"><span class="pre">pkg_preinst</span></code> phase functions. Exceptions to this policy can be +granted by the QA team.</p> +<p><em>Rationale</em>: using <code class="docutils literal notranslate"><span class="pre">D</span></code> in other phases (e.g. <code class="docutils literal notranslate"><span class="pre">src_configure</span></code>) is +error-prone and may lead to the path being embedded in files of the +installed image. In addition, the directory pointed to by <code class="docutils literal notranslate"><span class="pre">${D}</span></code> +does not exist in other phases.</p> +</section> </section> @@ -333,6 +353,7 @@ other hand, variables reduce the usefulness of plain tools such as grep.</p> <li class="toctree-l2"><a class="reference internal" href="#pg0104">SRC_URI must not refer to HOMEPAGE</a></li> <li class="toctree-l2"><a class="reference internal" href="#pg0105">KEYWORDS must be defined on a single line</a></li> <li class="toctree-l2"><a class="reference internal" href="#pg0106">LICENSE must not contain variables</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0107">D must be used only in src_install and pkg_preinst</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="filesystem.html">File system layout</a></li> @@ -361,7 +382,7 @@ other hand, variables reduce the usefulness of plain tools such as grep.</p> <h3 class="footerhead">Gentoo Policy Guide </h3> <div class="row"> <div class="col-xs-12 col-md-4"> - <span class="kk-group-header">Powered by</span><br><span><a href="http://sphinx-doc.org/">Sphinx 4.5.0</a> & <a href="https://github.com/mmagorsc/tyrian_sphinx_theme">Tyrian Theme 0.0.7</a></span> + <span class="kk-group-header">Powered by</span><br><span><a href="http://sphinx-doc.org/">Sphinx 6.1.3</a> & <a href="https://github.com/mmagorsc/tyrian_sphinx_theme">Tyrian Theme 0.0.7</a></span> </div> <div class="col-xs-12 col-md-4"> </div> @@ -378,11 +399,12 @@ other hand, variables reduce the usefulness of plain tools such as grep.</p> <div class="col-xs-2 col-sm-3 col-md-2"> <ul class="footerlinks three-icons"> <li><a href="https://twitter.com/gentoo" title="@Gentoo on Twitter"><span class="fa fa-twitter fa-fw"></span></a></li> + <li><a href="https://plus.google.com/+Gentoo" title="+Gentoo on Google+"><span class="fa fa-google-plus fa-fw"></span></a></li> <li><a href="https://www.facebook.com/gentoo.org" title="Gentoo on Facebook"><span class="fa fa-facebook fa-fw"></span></a></li> </ul> </div> <div class="col-xs-10 col-sm-9 col-md-10"> - <strong>© 2001–2022 Gentoo Authors</strong><br> + <strong>© 2001–2023 Gentoo Authors, Inc.</strong><br> <small> Gentoo is a trademark of the Gentoo Foundation, Inc. The contents of this document, unless otherwise expressly stated, are licensed under the |