diff options
Diffstat (limited to 'other-metadata.html')
| -rw-r--r-- | other-metadata.html | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/other-metadata.html b/other-metadata.html index 4a71d7d..2df22e5 100644 --- a/other-metadata.html +++ b/other-metadata.html @@ -150,6 +150,65 @@ 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> +<dl class="field-list simple"> +<dt class="field-odd">Source</dt> +<dd class="field-odd"><p>QA</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> +</dd> +<dt class="field-odd">Reported</dt> +<dd class="field-odd"><p>known bad values are reported by pkgcheck</p> +</dd> +</dl> +<p>The HOMEPAGE specified for the package should either be dedicated +to the package in question or make it easy to find dedicated +information. Packages must not use <code class="docutils literal notranslate"><span class="pre">https://www.gentoo.org/</span></code> +or a similar generic homepage. If no homepage is available, the special +value of <code class="docutils literal notranslate"><span class="pre">https://wiki.gentoo.org/wiki/No_homepage</span></code> must be used.</p> +<p><em>Rationale</em>: The homepage specified in ebuilds is normally used to +locate information about the upstream project, e.g. downloads, source +code repository, bug tracker, documentation. Homepages that make it +hard to locate information about a specific project have little value, +and the Gentoo homepage generally does not do a good job at linking even +major Gentoo projects. Furthermore, many of the projects did not even +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> +<dl class="field-list simple"> +<dt class="field-odd">Source</dt> +<dd class="field-odd"><p>QA</p> +</dd> +<dt class="field-even">Reported</dt> +<dd class="field-even"><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 +(or another flag with a similar purpose), it must explicitly restrict +tests when the flag is unset.</p> +<p><em>Example</em>:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">IUSE</span><span class="o">=</span><span class="s2">"test"</span> +<span class="n">RESTRICT</span><span class="o">=</span><span class="s2">"!test? ( test )"</span> +</pre></div> +</div> +<p><em>Rationale</em>: contrary to common assumption, <code class="docutils literal notranslate"><span class="pre">test</span></code> flag is not special +and the package manager can execute tests when the flag is disabled. +The explicit restriction guarantees that tests will be skipped under +this circumstance, and they will not fail for users.</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>Technically there are packages that do not strictly require this +restriction since they handle missing test prerequisites gracefully +(e.g. by skipping the tests). However, we enforce the rule for all +packages since omitting the restriction by mistake is much more +common, and there is little harm in overspecifying it.</p> +</div> +</div> </div> @@ -207,6 +266,8 @@ invalidation or explicit errors.</p> <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> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="use-flags.html">USE flags</a></li> |