diff options
Diffstat (limited to 'other-metadata.html')
| -rw-r--r-- | other-metadata.html | 138 |
1 files changed, 107 insertions, 31 deletions
diff --git a/other-metadata.html b/other-metadata.html index 994d4dc..f9e7132 100644 --- a/other-metadata.html +++ b/other-metadata.html @@ -15,10 +15,10 @@ <link href="https://assets.gentoo.org/tyrian/bootstrap.min.css" rel="stylesheet" media="screen"> <link href="https://assets.gentoo.org/tyrian/tyrian.min.css" rel="stylesheet" media="screen"> <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 src="_static/jquery.js"></script> + <script src="_static/underscore.js"></script> + <script src="_static/doctools.js"></script> + <script src="_static/language_data.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="USE flags" href="use-flags.html" /> @@ -76,8 +76,25 @@ <li class=""><a href="_sources/other-metadata.rst.txt">Source</a></li> <li> <a href="search.html">Search</a></li> + + + <li> + + <a href="genindex.html">General Index</a> + + </li> + <li> - <a href="genindex.html">Index</a></li> + + <a href="std-policy-index.html">Policy Index</a> + + </li> + + + + + + @@ -115,17 +132,20 @@ <div class="section" id="other-metadata-variables"> <h1>Other metadata variables<a class="headerlink" href="#other-metadata-variables" title="Permalink to this headline">¶</a></h1> -<span class="target" id="index-0"></span><div class="section" id="dynamic-slots-multislot-flag"> -<span id="index-1"></span><h2>Dynamic slots (multislot flag)<a class="headerlink" href="#dynamic-slots-multislot-flag" title="Permalink to this headline">¶</a></h2> +<span class="target" id="index-0"></span><div class="section" id="pg0701"> +<span id="dynamic-slots-multislot-flag"></span><span id="index-1"></span><h2>Dynamic slots (multislot flag)<a class="headerlink" href="#pg0701" title="Permalink to this headline">¶</a></h2> <dl class="field-list simple"> -<dt class="field-odd">Source</dt> -<dd class="field-odd"><p>QA (inferred from PMS)</p> +<dt class="field-odd">PG</dt> +<dd class="field-odd"><p>0701</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=109991#multislot.2FUSE-dependent_SLOT">https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=109991#multislot.2FUSE-dependent_SLOT</a></p> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>QA (inferred from PMS)</p> </dd> -<dt class="field-odd">Reported</dt> -<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">use</span></code> in global scope triggers fatal error</p> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=109991#multislot.2FUSE-dependent_SLOT">https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=109991#multislot.2FUSE-dependent_SLOT</a></p> +</dd> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">use</span></code> in global scope triggers fatal error</p> </dd> </dl> <p>The use of <code class="docutils literal notranslate"><span class="pre">multislot</span></code> to alter <code class="docutils literal notranslate"><span class="pre">SLOT</span></code> values (as well as any other @@ -150,17 +170,20 @@ depend on slot, via <code class="docutils literal notranslate"><span class="pre" manager behavior which could include use of unpredictable slot, cache invalidation or explicit errors.</p> </div> -<div class="section" id="homepage-value-must-be-meaningful"> -<span id="index-2"></span><h2>HOMEPAGE value must be meaningful<a class="headerlink" href="#homepage-value-must-be-meaningful" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0702"> +<span id="homepage-value-must-be-meaningful"></span><span id="index-2"></span><h2>HOMEPAGE value must be meaningful<a class="headerlink" href="#pg0702" title="Permalink to this headline">¶</a></h2> <dl class="field-list simple"> -<dt class="field-odd">Source</dt> -<dd class="field-odd"><p>QA</p> +<dt class="field-odd">PG</dt> +<dd class="field-odd"><p>0702</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://archives.gentoo.org/gentoo-dev/message/83cc5bbd7bbe8bdf04dd3c3bc7f8a035">https://archives.gentoo.org/gentoo-dev/message/83cc5bbd7bbe8bdf04dd3c3bc7f8a035</a></p> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>QA</p> </dd> -<dt class="field-odd">Reported</dt> -<dd class="field-odd"><p>known bad values are reported by pkgcheck</p> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://archives.gentoo.org/gentoo-dev/message/83cc5bbd7bbe8bdf04dd3c3bc7f8a035">https://archives.gentoo.org/gentoo-dev/message/83cc5bbd7bbe8bdf04dd3c3bc7f8a035</a></p> +</dd> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>known bad values are reported by pkgcheck</p> </dd> </dl> <p>The HOMEPAGE specified for the package should either be dedicated @@ -178,14 +201,17 @@ have a single dedicated subpage anywhere in Gentoo web space. In all those cases, using the explicit No_homepage marker at least makes it easy to identify such packages.</p> </div> -<div class="section" id="restrict-test-for-use-test"> -<span id="index-3"></span><h2>RESTRICT=test for USE=-test<a class="headerlink" href="#restrict-test-for-use-test" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0703"> +<span id="restrict-test-for-use-test"></span><span id="index-3"></span><h2>RESTRICT=test for USE=-test<a class="headerlink" href="#pg0703" title="Permalink to this headline">¶</a></h2> <dl class="field-list simple"> -<dt class="field-odd">Source</dt> -<dd class="field-odd"><p>QA</p> +<dt class="field-odd">PG</dt> +<dd class="field-odd"><p>0703</p> </dd> -<dt class="field-even">Reported</dt> -<dd class="field-even"><p>by pkgcheck</p> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>QA</p> +</dd> +<dt class="field-odd">Reported</dt> +<dd class="field-odd"><p>by pkgcheck</p> </dd> </dl> <p>Whenever the package uses <code class="docutils literal notranslate"><span class="pre">test</span></code> flag to control test prerequisites @@ -209,6 +235,55 @@ packages since omitting the restriction by mistake is much more common, and there is little harm in overspecifying it.</p> </div> </div> +<div class="section" id="pg0704"> +<span id="license"></span><span id="index-4"></span><h2>LICENSE<a class="headerlink" href="#pg0704" title="Permalink to this headline">¶</a></h2> +<dl class="field-list simple"> +<dt class="field-odd">PG</dt> +<dd class="field-odd"><p>0704</p> +</dd> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>QA</p> +</dd> +<dt class="field-odd">Reported</dt> +<dd class="field-odd"><p>no</p> +</dd> +</dl> +<p>The <code class="docutils literal notranslate"><span class="pre">LICENSE</span></code> variable must explicitly list licenses for all files +installed by the package. If some of the applicable licenses are +conditional to USE flags, appropriate USE conditionals need to +be expressed in the variable.</p> +<p>If a package bundles any dependencies that are either installed, +statically linked or in any other way combined with installed files, +the licenses of these dependencies need to be listed as well. This +is not presently required when statically linking to dependencies +installed by separate packages in the repository.</p> +<p>The licenses for files that are not installed but that are used at build +time are not listed explicitly.</p> +<p><em>Rationale</em>: the primary purpose of the license support in the package +manager is to provide the users with ability to decide on acceptable +licenses for their installed systems (and binary packages). In order +for this to work effectively, the packages must provide a correct +and complete license list.</p> +<p>Static linking combines code from multiple packages, potentially covered +by different licenses. Listing all licenses is the simplest way +of ensuring that nothing is missed, as well as protecting against wrong +derivative work licenses stated upstream (i.e. when a less restrictively +licensed package links to a more restrictively licensed dependency).</p> +<p>Listing of licenses is enforced for bundled dependencies but not for +static linking to other packages, as in the latter case it is +non-trivial to implement and the package manager already verifies +the license while building dependencies (but not when installing binary +packages).</p> +<p>The ebuild format does not provide a separate variable to list licenses +needed only at build time. So far it has not been considered important +enough to have one, as the relevant files exist only temporarily +on the user’s system and do not affect the runtime use of packages.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>Please remember to include the licenses of support files provided +by the ebuild, e.g. init.d scripts (usually GPL-2).</p> +</div> +</div> </div> @@ -265,9 +340,10 @@ common, and there is little harm in overspecifying it.</p> <li class="toctree-l1"><a class="reference internal" href="languages.html">Language-specific policies</a></li> <li class="toctree-l1"><a class="reference internal" href="maintainer.html">Package Maintainers</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Other metadata variables</a><ul class='nav'> -<li class="toctree-l2"><a class="reference internal" href="#dynamic-slots-multislot-flag">Dynamic slots (multislot flag)</a></li> -<li class="toctree-l2"><a class="reference internal" href="#homepage-value-must-be-meaningful">HOMEPAGE value must be meaningful</a></li> -<li class="toctree-l2"><a class="reference internal" href="#restrict-test-for-use-test">RESTRICT=test for USE=-test</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0701">Dynamic slots (multislot flag)</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0702">HOMEPAGE value must be meaningful</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0703">RESTRICT=test for USE=-test</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0704">LICENSE</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="use-flags.html">USE flags</a></li> @@ -290,7 +366,7 @@ common, and there is little harm in overspecifying it.</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 2.3.1</a> & <a href="https://github.com/mmagorsc/tyrian_sphinx_theme">Tyrian Theme 0.0.2</a></span> + <span class="kk-group-header">Powered by</span><br><span><a href="http://sphinx-doc.org/">Sphinx 2.4.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> |