summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlrich Müller <ulm@gentoo.org>2023-01-18 18:37:14 +0100
committerUlrich Müller <ulm@gentoo.org>2023-01-18 18:37:14 +0100
commit80a619f5410ed6dba1b68c16be98f95343844658 (patch)
tree092dc760bd7b06c00066d259aac8dd4d5a0c826b /installed-files.html
parentRebuild (diff)
downloadpolicy-guide-80a619f5410ed6dba1b68c16be98f95343844658.tar.gz
policy-guide-80a619f5410ed6dba1b68c16be98f95343844658.tar.bz2
policy-guide-80a619f5410ed6dba1b68c16be98f95343844658.zip
Rebuild
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
Diffstat (limited to 'installed-files.html')
-rw-r--r--installed-files.html33
1 files changed, 32 insertions, 1 deletions
diff --git a/installed-files.html b/installed-files.html
index 1e1d767..b1cfc7c 100644
--- a/installed-files.html
+++ b/installed-files.html
@@ -192,6 +192,14 @@ support for packages practically impossible. It may be used whenever
really necessary (e.g. for recovery tools) but otherwise proliferating
it is considered harmful. There is no point in installing static
libraries if they are never going to be used.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>If the package’s build system does not support disabling static
+library build, it is recommended to patch it and submit the patch
+upstream. However, if that is not feasible and building both shared
+and static libraries does not require compiling source files twice,
+it is acceptable to strip static libraries in <code class="docutils literal notranslate"><span class="pre">src_install()</span></code>.</p>
+</div>
</section>
<section id="pg0303">
<span id="installation-of-libtool-la-files"></span><span id="index-2"></span><h2>Installation of libtool (.la) files<a class="headerlink" href="#pg0303" title="Permalink to this heading">¶</a></h2>
@@ -247,6 +255,28 @@ optimizations. Also QA tools make certain assumptions about virtuals,
e.g., that they must not assign the <code class="docutils literal notranslate"><span class="pre">LICENSE</span></code> variable (which would
be impossible if they installed any files).</p>
</section>
+<section id="pg0305">
+<span id="installation-of-manpages"></span><span id="index-4"></span><h2>Installation of manpages<a class="headerlink" href="#pg0305" 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>0305</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>Packages must not disable installing manpages via USE flags (e.g.
+<code class="docutils literal notranslate"><span class="pre">USE=man</span></code> or <code class="docutils literal notranslate"><span class="pre">USE=doc</span></code>). If upstream does not ship prebuilt
+manpages and building them requires additional dependencies,
+the maintainer should build them and ship along with the package.</p>
+<p><em>Rationale</em>: Manpages are basic documentation for installed software.
+While additional dependencies are inconvenient for users, not building
+manpages is harmful. Including (optionally or unconditionally)
+prebuilt manpages is a good compromise.</p>
+</section>
</section>
@@ -295,6 +325,7 @@ be impossible if they installed any files).</p>
<li class="toctree-l1"><a class="reference internal" href="motivation.html">Motivation and history</a></li>
<li class="toctree-l1"><a class="reference internal" href="basics.html">Basic information</a></li>
<li class="toctree-l1"><a class="reference internal" href="other-docs.html">Other policy documents</a></li>
+<li class="toctree-l1"><a class="reference internal" href="editing.html">Editing and publishing updates to this Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecation.html">Deprecations</a></li>
<li class="toctree-l1"><a class="reference internal" href="ebuild-format.html">Ebuild file format</a></li>
@@ -304,6 +335,7 @@ be impossible if they installed any files).</p>
<li class="toctree-l2"><a class="reference internal" href="#pg0302">Installation of static libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0303">Installation of libtool (.la) files</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pg0304">Virtuals</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#pg0305">Installation of manpages</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="keywords.html">Keywording and stabilization</a></li>
@@ -347,7 +379,6 @@ be impossible if they installed any files).</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>