diff options
author | 2020-02-25 16:16:18 +0100 | |
---|---|---|
committer | 2020-02-25 16:16:18 +0100 | |
commit | 3acb91f3c49d455504c9c5f72b6266c2327e8ab6 (patch) | |
tree | 1130807ddb73da3beeefcf1868ecc60b3a5025c4 | |
parent | Rebuild with updated theme (diff) | |
download | policy-guide-3acb91f3c49d455504c9c5f72b6266c2327e8ab6.tar.gz policy-guide-3acb91f3c49d455504c9c5f72b6266c2327e8ab6.tar.bz2 policy-guide-3acb91f3c49d455504c9c5f72b6266c2327e8ab6.zip |
Update for PG idents
Signed-off-by: Michał Górny <mgorny@gentoo.org>
32 files changed, 1001 insertions, 430 deletions
diff --git a/_sources/dependencies.rst.txt b/_sources/dependencies.rst.txt index 55bba5c..a1f5177 100644 --- a/_sources/dependencies.rst.txt +++ b/_sources/dependencies.rst.txt @@ -6,6 +6,7 @@ Dependencies Optional runtime dependencies ----------------------------- +:PG: 0001 :Source: QA :Reference: https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=104017#USE-Controlled_Optional_RDEPENDS :Reported: no @@ -35,6 +36,7 @@ This is especially important for packages that take long time to build. =-dependencies with no revision ------------------------------- +:PG: 0002 :Source: QA :Reported: by repoman and pkgcheck @@ -67,6 +69,7 @@ Slot and subslot dependencies on (sub-)slotted packages ~~~~~~~~~~~~~~~~~~~~~~~~~ +:PG: 0011 :Source: QA :Reference: https://archives.gentoo.org/gentoo-portage-dev/message/9cae3a92412a007febe7ac0612d50f5f :Reported: by repoman and pkgcheck @@ -100,6 +103,7 @@ means 'verified that any slot is acceptable'. special case: Qt packages ~~~~~~~~~~~~~~~~~~~~~~~~~ +:PG: 0012 :Source: Qt project :Reference: https://wiki.gentoo.org/wiki/Project:Qt/Policies#Dependencies :Reported: no @@ -132,6 +136,7 @@ They point out the case of Qt packages as an example. Revision bumps on runtime dependency changes -------------------------------------------- +:PG: 0003 :Source: Council :Reference: https://projects.gentoo.org/council/meeting-logs/20151011-summary.txt :Reported: no @@ -175,6 +180,7 @@ USE dependencies on packages without the flag ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +:PG: 0021 :Source: QA (inferred from PMS) :Reported: by pkgcheck diff --git a/_sources/ebuild-format.rst.txt b/_sources/ebuild-format.rst.txt index d2c8dc5..a5bf5aa 100644 --- a/_sources/ebuild-format.rst.txt +++ b/_sources/ebuild-format.rst.txt @@ -8,6 +8,7 @@ Ebuild file format Coding style ------------ +:PG: 0101 :Source: QA :Reported: partially via repoman and pkgcheck @@ -32,6 +33,7 @@ the ebuild. Code must be contained within ebuild and eclasses ------------------------------------------------- +:PG: 0102 :Source: QA :Reference: https://bugs.gentoo.org/612630 :Reported: no @@ -54,6 +56,7 @@ that possibility, including linting tools. HOMEPAGE must not contain variables ----------------------------------- +:PG: 0103 :Source: QA :Reported: by pkgcheck, highlighted as error by gentoo-syntax @@ -68,12 +71,12 @@ preprocessing, breaking URI support in terminals and editors, as well as reducing the usefulness of plain tools such as grep. - .. index:: pair: src uri; homepage SRC_URI must not refer to HOMEPAGE ---------------------------------- +:PG: 0104 :Source: QA :Reported: by pkgcheck @@ -87,3 +90,21 @@ incidentally depend on multi-valued variable having a single value goes against the principle of least surprise. Furthermore, it makes it hard to copy-paste part of the URI e.g. to investigate the directory index. + + +.. index:: keywords; one line + +KEYWORDS must be defined on a single line +----------------------------------------- +:PG: 0105 +:Source: QA +:Reported: no + +The ``KEYWORDS`` variable must be defined at most once in an ebuild, +on a single line, with literal content (no variable references, line +wrapping, appending, etc.). + +*Rationale*: it is common for arch teams to use the ``ekeyword`` tool +when working with large number of ebuilds. The tool has only limited +ability to process and modify ebuilds, and therefore developers must +make sure that it works correctly on their ebuilds. diff --git a/_sources/filesystem.rst.txt b/_sources/filesystem.rst.txt index 081ab99..52e20a3 100644 --- a/_sources/filesystem.rst.txt +++ b/_sources/filesystem.rst.txt @@ -5,6 +5,7 @@ File system layout Installation paths ------------------ +:PG: 0201 :Source: QA :Reference: https://gitweb.gentoo.org/repo/gentoo.git/tree/metadata/install-qa-check.d/08gentoo-paths :Reported: via install-qa-check.d @@ -60,6 +61,7 @@ exceptions are: Support for separate /usr ------------------------- +:PG: 0202 :Source: QA :Reference: https://projects.gentoo.org/council/meeting-logs/20130813-summary.txt https://projects.gentoo.org/council/meeting-logs/20130924-summary.txt @@ -79,6 +81,7 @@ from rootfs to initramfs. Strict multilib layout ---------------------- +:PG: 0203 :Source: QA :Reference: https://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80multilib-strict :Reported: via install-qa-check.d, fatal @@ -103,6 +106,7 @@ to be correctly found by the dynamic loader. Static libraries and libtool files ---------------------------------- +:PG: 0204 :Source: QA :Reference: https://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80libraries :Reported: via install-qa-check.d, fatal @@ -124,6 +128,7 @@ be a waste of space. Game install locations and ownership ------------------------------------ +:PG: 0205 :Source: Council, clarified by QA :Reference: https://projects.gentoo.org/council/meeting-logs/20151213-summary.txt https://projects.gentoo.org/council/meeting-logs/20151011-summary.txt @@ -160,6 +165,7 @@ fulfill that purpose. Absolute symbolic link targets ------------------------------ +:PG: 0206 :Source: QA :Reported: by repoman and pkgcheck (when ebuild-generated) diff --git a/_sources/installed-files.rst.txt b/_sources/installed-files.rst.txt index b77bc02..c8c55f2 100644 --- a/_sources/installed-files.rst.txt +++ b/_sources/installed-files.rst.txt @@ -7,6 +7,7 @@ Installed files Installation of small files --------------------------- +:PG: 0301 :Source: QA :Reported: no @@ -40,6 +41,7 @@ such a huge package in order to install one tiny file. Installation of static libraries -------------------------------- +:PG: 0302 :Source: QA :Reported: no @@ -61,6 +63,7 @@ libraries if they are never going to be used. Installation of libtool (.la) files ----------------------------------- +:PG: 0303 :Source: QA :Reported: no diff --git a/_sources/keywords.rst.txt b/_sources/keywords.rst.txt index 272dca4..81db271 100644 --- a/_sources/keywords.rst.txt +++ b/_sources/keywords.rst.txt @@ -5,6 +5,7 @@ Keywording and stabilization Rekeywording on dropped keywords -------------------------------- +:PG: 0401 :Source: QA :Reported: by pkgcheck and repoman @@ -23,6 +24,7 @@ a new version or to remove an old version. Stabilizing new versions ------------------------ +:PG: 0402 :Source: QA :Reported: by pkgcheck @@ -50,6 +52,7 @@ requested on remaining architectures in the first place. Removing stable keywords ------------------------ +:PG: 0403 :Source: QA :Reference: https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=126033#Dropping_Stable_KEYWORDs :Reported: n/a diff --git a/_sources/languages.rst.txt b/_sources/languages.rst.txt index b84a80c..dc3a142 100644 --- a/_sources/languages.rst.txt +++ b/_sources/languages.rst.txt @@ -13,6 +13,7 @@ Python Eclass usage ~~~~~~~~~~~~ +:PG: 0501 :Source: Python project :Reference: https://wiki.gentoo.org/wiki/Project:Python/Eclasses :Reported: by pkgcheck @@ -41,6 +42,7 @@ implementations with minimal changes to existing ebuilds. Python 2 deprecation ~~~~~~~~~~~~~~~~~~~~ +:PG: 0502 :Source: Python project :Reference: https://wiki.gentoo.org/wiki/Project:Python#Python_2_end-of-life :Reported: no diff --git a/_sources/maintainer.rst.txt b/_sources/maintainer.rst.txt index 07dd3b1..e37daf4 100644 --- a/_sources/maintainer.rst.txt +++ b/_sources/maintainer.rst.txt @@ -5,6 +5,7 @@ Package Maintainers Adding new maintainers ---------------------- +:PG: 0601 :Source: QA :Reported: no @@ -31,6 +32,7 @@ them from packages actually within project's profile was hard. New packages without a maintainer --------------------------------- +:PG: 0602 :Source: QA :Reported: no @@ -50,6 +52,7 @@ to take care of them. Removing package maintainers ---------------------------- +:PG: 0603 :Source: QA :Reported: no diff --git a/_sources/other-metadata.rst.txt b/_sources/other-metadata.rst.txt index f05014b..c59e0c2 100644 --- a/_sources/other-metadata.rst.txt +++ b/_sources/other-metadata.rst.txt @@ -6,6 +6,7 @@ Other metadata variables Dynamic slots (multislot flag) ------------------------------ +:PG: 0701 :Source: QA (inferred from PMS) :Reference: https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=109991#multislot.2FUSE-dependent_SLOT :Reported: ``use`` in global scope triggers fatal error @@ -42,6 +43,7 @@ invalidation or explicit errors. HOMEPAGE value must be meaningful --------------------------------- +:PG: 0702 :Source: QA :Reference: https://archives.gentoo.org/gentoo-dev/message/83cc5bbd7bbe8bdf04dd3c3bc7f8a035 :Reported: known bad values are reported by pkgcheck @@ -69,6 +71,7 @@ easy to identify such packages. RESTRICT=test for USE=-test --------------------------- +:PG: 0703 :Source: QA :Reported: by pkgcheck @@ -94,4 +97,54 @@ this circumstance, and they will not fail for users. common, and there is little harm in overspecifying it. +.. index:: license + +LICENSE +------- +:PG: 0704 +:Source: QA +:Reported: no + +The ``LICENSE`` 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. + +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. + +The licenses for files that are not installed but that are used at build +time are not listed explicitly. + +*Rationale*: 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. + +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). + +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). + +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. + +.. Note:: + Please remember to include the licenses of support files provided + by the ebuild, e.g. init.d scripts (usually GPL-2). + + .. _metadata invariance: https://projects.gentoo.org/pms/7/pms.html#x1-600007.1 diff --git a/_sources/use-flags.rst.txt b/_sources/use-flags.rst.txt index c6a8b4a..4344edc 100644 --- a/_sources/use-flags.rst.txt +++ b/_sources/use-flags.rst.txt @@ -8,6 +8,7 @@ USE flags Versioned USE flags ------------------- +:PG: 0801 :Source: QA :Reference: https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=109991#Versioned_USE_flags :Reported: no @@ -38,6 +39,7 @@ with the QA team before introduction. USE=gui flag ------------ +:PG: 0802 :Source: QA :Reference: https://archives.gentoo.org/gentoo-dev/message/cf3f5a59ac918335766632bd02438722 :Reported: no @@ -61,6 +63,7 @@ multiple GUIs. Underscores in USE flag names ----------------------------- +:PG: 0803 :Source: Council :Reference: https://projects.gentoo.org/council/meeting-logs/20191013-summary.txt :Reported: by pkgcheck diff --git a/_sources/user-group.rst.txt b/_sources/user-group.rst.txt index 389f3b9..09944a5 100644 --- a/_sources/user-group.rst.txt +++ b/_sources/user-group.rst.txt @@ -6,6 +6,7 @@ Users and groups User and group account policy ----------------------------- +:PG: 0901 :Source: QA :Reference: https://bugs.gentoo.org/702460 :Reported: by repoman and pkgcheck (as deprecated eclass) diff --git a/_static/basic.css b/_static/basic.css index b04360d..0119285 100644 --- a/_static/basic.css +++ b/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/_static/doctools.js b/_static/doctools.js index b33f87f..daccd20 100644 --- a/_static/doctools.js +++ b/_static/doctools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for all documentation. * - * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -283,10 +283,11 @@ var Documentation = { }, initOnKeyListeners: function() { - $(document).keyup(function(event) { + $(document).keydown(function(event) { var activeElementType = document.activeElement.tagName; // don't navigate when in search box or textarea - if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') { + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) { switch (event.keyCode) { case 37: // left var prevHref = $('link[rel="prev"]').prop('href'); diff --git a/_static/language_data.js b/_static/language_data.js index 5266fb1..d2b4ee9 100644 --- a/_static/language_data.js +++ b/_static/language_data.js @@ -5,7 +5,7 @@ * This script contains the language-specific data used by searchtools.js, * namely the list of stopwords, stemmer, scorer and splitter. * - * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/_static/searchtools.js b/_static/searchtools.js index ad84587..d11b33a 100644 --- a/_static/searchtools.js +++ b/_static/searchtools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for the full-text search. * - * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -63,6 +63,11 @@ var Search = { htmlElement.innerHTML = htmlString; $(htmlElement).find('.headerlink').remove(); docContent = $(htmlElement).find('[role=main]')[0]; + if(docContent === undefined) { + console.warn("Content block not found. Sphinx search tries to obtain it " + + "via '[role=main]'. Could you check your theme or template."); + return ""; + } return docContent.textContent || docContent.innerText; }, @@ -245,6 +250,7 @@ var Search = { if (results.length) { var item = results.pop(); var listItem = $('<li style="display:none"></li>'); + var requestUrl = ""; if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') { // dirhtml builder var dirname = item[0] + '/'; @@ -253,15 +259,15 @@ var Search = { } else if (dirname == 'index/') { dirname = ''; } - listItem.append($('<a/>').attr('href', - DOCUMENTATION_OPTIONS.URL_ROOT + dirname + - highlightstring + item[2]).html(item[1])); + requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname; + } else { // normal html builders - listItem.append($('<a/>').attr('href', - item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + - highlightstring + item[2]).html(item[1])); + requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX; } + listItem.append($('<a/>').attr('href', + requestUrl + + highlightstring + item[2]).html(item[1])); if (item[3]) { listItem.append($('<span> (' + item[3] + ')</span>')); Search.output.append(listItem); @@ -269,7 +275,7 @@ var Search = { displayNextItem(); }); } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { - $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX, + $.ajax({url: requestUrl, dataType: "text", complete: function(jqxhr, textstatus) { var data = jqxhr.responseText; diff --git a/basics.html b/basics.html index 68f5c68..a9efb4c 100644 --- a/basics.html +++ b/basics.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="Other policy documents" href="other-docs.html" /> @@ -76,8 +76,25 @@ <li class=""><a href="_sources/basics.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> + + + + + + @@ -264,7 +281,7 @@ be appealed to the <a class="reference external" href="https://wiki.gentoo.org/w <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> diff --git a/dependencies.html b/dependencies.html index 3011108..c014c8b 100644 --- a/dependencies.html +++ b/dependencies.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="Ebuild file format" href="ebuild-format.html" /> @@ -76,8 +76,25 @@ <li class=""><a href="_sources/dependencies.rst.txt">Source</a></li> <li> <a href="search.html">Search</a></li> + + <li> - <a href="genindex.html">Index</a></li> + + <a href="genindex.html">General Index</a> + + </li> + + <li> + + <a href="std-policy-index.html">Policy Index</a> + + </li> + + + + + + @@ -115,17 +132,20 @@ <div class="section" id="dependencies"> <h1>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h1> -<span class="target" id="index-0"></span><div class="section" id="optional-runtime-dependencies"> -<span id="index-1"></span><h2>Optional runtime dependencies<a class="headerlink" href="#optional-runtime-dependencies" title="Permalink to this headline">¶</a></h2> +<span class="target" id="index-0"></span><div class="section" id="pg0001"> +<span id="optional-runtime-dependencies"></span><span id="index-1"></span><h2>Optional runtime dependencies<a class="headerlink" href="#pg0001" 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>0001</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=104017#USE-Controlled_Optional_RDEPENDS">https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=104017#USE-Controlled_Optional_RDEPENDS</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>no</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=104017#USE-Controlled_Optional_RDEPENDS">https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=104017#USE-Controlled_Optional_RDEPENDS</a></p> +</dd> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>no</p> </dd> </dl> <p>Using USE flags to control optional runtime dependencies is not @@ -146,14 +166,17 @@ rebuilding package in question. It has been tentatively approved by the Council but no reference implementation has been written.</p> </div> </div> -<div class="section" id="dependencies-with-no-revision"> -<span id="index-2"></span><h2>=-dependencies with no revision<a class="headerlink" href="#dependencies-with-no-revision" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0002"> +<span id="dependencies-with-no-revision"></span><span id="index-2"></span><h2>=-dependencies with no revision<a class="headerlink" href="#pg0002" 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>0002</p> </dd> -<dt class="field-even">Reported</dt> -<dd class="field-even"><p>by repoman and 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 repoman and pkgcheck</p> </dd> </dl> <p>Whenever a non-wildcard <code class="docutils literal notranslate"><span class="pre">=</span></code> (equals) dependency is used on a package, @@ -177,17 +200,20 @@ used the correct operator.</p> </div> <div class="section" id="slot-and-subslot-dependencies"> <span id="index-3"></span><h2>Slot and subslot dependencies<a class="headerlink" href="#slot-and-subslot-dependencies" title="Permalink to this headline">¶</a></h2> -<div class="section" id="on-sub-slotted-packages"> -<h3>on (sub-)slotted packages<a class="headerlink" href="#on-sub-slotted-packages" title="Permalink to this headline">¶</a></h3> +<div class="section" id="pg0011"> +<span id="on-sub-slotted-packages"></span><h3>on (sub-)slotted packages<a class="headerlink" href="#pg0011" title="Permalink to this headline">¶</a></h3> <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>0011</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://archives.gentoo.org/gentoo-portage-dev/message/9cae3a92412a007febe7ac0612d50f5f">https://archives.gentoo.org/gentoo-portage-dev/message/9cae3a92412a007febe7ac0612d50f5f</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>by repoman and pkgcheck</p> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://archives.gentoo.org/gentoo-portage-dev/message/9cae3a92412a007febe7ac0612d50f5f">https://archives.gentoo.org/gentoo-portage-dev/message/9cae3a92412a007febe7ac0612d50f5f</a></p> +</dd> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>by repoman and pkgcheck</p> </dd> </dl> <p>Whenever a package dependency specification matches a range of versions @@ -211,17 +237,20 @@ is specified on the dependency. It pulls in the slot corresponding to the newest package version available.</p> </div> </div> -<div class="section" id="special-case-qt-packages"> -<span id="index-4"></span><h3>special case: Qt packages<a class="headerlink" href="#special-case-qt-packages" title="Permalink to this headline">¶</a></h3> +<div class="section" id="pg0012"> +<span id="special-case-qt-packages"></span><span id="index-4"></span><h3>special case: Qt packages<a class="headerlink" href="#pg0012" title="Permalink to this headline">¶</a></h3> <dl class="field-list simple"> -<dt class="field-odd">Source</dt> -<dd class="field-odd"><p>Qt project</p> +<dt class="field-odd">PG</dt> +<dd class="field-odd"><p>0012</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://wiki.gentoo.org/wiki/Project:Qt/Policies#Dependencies">https://wiki.gentoo.org/wiki/Project:Qt/Policies#Dependencies</a></p> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>Qt project</p> </dd> -<dt class="field-odd">Reported</dt> -<dd class="field-odd"><p>no</p> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://wiki.gentoo.org/wiki/Project:Qt/Policies#Dependencies">https://wiki.gentoo.org/wiki/Project:Qt/Policies#Dependencies</a></p> +</dd> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>no</p> </dd> </dl> <p>The Qt packages use subslots in an uncommon way. The public ABI of Qt @@ -244,17 +273,20 @@ predictable.</p> They point out the case of Qt packages as an example.</p> </div> </div> -<div class="section" id="revision-bumps-on-runtime-dependency-changes"> -<span id="index-5"></span><h2>Revision bumps on runtime dependency changes<a class="headerlink" href="#revision-bumps-on-runtime-dependency-changes" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0003"> +<span id="revision-bumps-on-runtime-dependency-changes"></span><span id="index-5"></span><h2>Revision bumps on runtime dependency changes<a class="headerlink" href="#pg0003" title="Permalink to this headline">¶</a></h2> <dl class="field-list simple"> -<dt class="field-odd">Source</dt> -<dd class="field-odd"><p>Council</p> +<dt class="field-odd">PG</dt> +<dd class="field-odd"><p>0003</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://projects.gentoo.org/council/meeting-logs/20151011-summary.txt">https://projects.gentoo.org/council/meeting-logs/20151011-summary.txt</a></p> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>Council</p> </dd> -<dt class="field-odd">Reported</dt> -<dd class="field-odd"><p>no</p> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://projects.gentoo.org/council/meeting-logs/20151011-summary.txt">https://projects.gentoo.org/council/meeting-logs/20151011-summary.txt</a></p> +</dd> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>no</p> </dd> </dl> <p>It must not be assumed that changes to package’s dependencies will @@ -286,14 +318,17 @@ if the package installed by the user still links to libfoo.</p> </div> <div class="section" id="use-dependencies"> <span id="index-6"></span><h2>USE dependencies<a class="headerlink" href="#use-dependencies" title="Permalink to this headline">¶</a></h2> -<div class="section" id="on-packages-without-the-flag"> -<h3>on packages without the flag<a class="headerlink" href="#on-packages-without-the-flag" title="Permalink to this headline">¶</a></h3> +<div class="section" id="pg0021"> +<span id="on-packages-without-the-flag"></span><h3>on packages without the flag<a class="headerlink" href="#pg0021" title="Permalink to this headline">¶</a></h3> <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>0021</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 (inferred from PMS)</p> +</dd> +<dt class="field-odd">Reported</dt> +<dd class="field-odd"><p>by pkgcheck</p> </dd> </dl> <p>Whenever a package uses a 2-style USE-dependency on another package, @@ -372,17 +407,17 @@ updating its reverse dependencies.</p> <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 current"><a class="current reference internal" href="#">Dependencies</a><ul class='nav'> -<li class="toctree-l2"><a class="reference internal" href="#optional-runtime-dependencies">Optional runtime dependencies</a></li> -<li class="toctree-l2"><a class="reference internal" href="#dependencies-with-no-revision">=-dependencies with no revision</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0001">Optional runtime dependencies</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0002">=-dependencies with no revision</a></li> <li class="toctree-l2"><a class="reference internal" href="#slot-and-subslot-dependencies">Slot and subslot dependencies</a><ul class='nav'> -<li class="toctree-l3"><a class="reference internal" href="#on-sub-slotted-packages">on (sub-)slotted packages</a></li> -<li class="toctree-l3"><a class="reference internal" href="#special-case-qt-packages">special case: Qt packages</a></li> +<li class="toctree-l3"><a class="reference internal" href="#pg0011">on (sub-)slotted packages</a></li> +<li class="toctree-l3"><a class="reference internal" href="#pg0012">special case: Qt packages</a></li> <li class="toctree-l3"><a class="reference internal" href="#proactive-use-of-slot-operators">proactive use of slot operators</a></li> </ul> </li> -<li class="toctree-l2"><a class="reference internal" href="#revision-bumps-on-runtime-dependency-changes">Revision bumps on runtime dependency changes</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0003">Revision bumps on runtime dependency changes</a></li> <li class="toctree-l2"><a class="reference internal" href="#use-dependencies">USE dependencies</a><ul class='nav'> -<li class="toctree-l3"><a class="reference internal" href="#on-packages-without-the-flag">on packages without the flag</a></li> +<li class="toctree-l3"><a class="reference internal" href="#pg0021">on packages without the flag</a></li> </ul> </li> </ul> @@ -414,7 +449,7 @@ updating its reverse dependencies.</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> diff --git a/ebuild-format.html b/ebuild-format.html index 3a89fb2..74402f5 100644 --- a/ebuild-format.html +++ b/ebuild-format.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="File system layout" href="filesystem.html" /> @@ -76,8 +76,25 @@ <li class=""><a href="_sources/ebuild-format.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,14 +132,17 @@ <div class="section" id="ebuild-file-format"> <h1>Ebuild file format<a class="headerlink" href="#ebuild-file-format" title="Permalink to this headline">¶</a></h1> -<div class="section" id="coding-style"> -<span id="index-0"></span><h2>Coding style<a class="headerlink" href="#coding-style" title="Permalink to this headline">¶</a></h2> +<div class="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> <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>0101</p> </dd> -<dt class="field-even">Reported</dt> -<dd class="field-even"><p>partially via repoman and 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>partially via repoman and pkgcheck</p> </dd> </dl> <p>While Gentoo leaves most of the coding style choices to developers, @@ -139,17 +159,20 @@ or <code class="docutils literal notranslate"><span class="pre">test</span></cod Consistency avoids unnecessary changes when other developers edit the ebuild.</p> </div> -<div class="section" id="code-must-be-contained-within-ebuild-and-eclasses"> -<span id="index-1"></span><h2>Code must be contained within ebuild and eclasses<a class="headerlink" href="#code-must-be-contained-within-ebuild-and-eclasses" title="Permalink to this headline">¶</a></h2> +<div class="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> <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>0102</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://bugs.gentoo.org/612630">https://bugs.gentoo.org/612630</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>no</p> +<dt class="field-odd">Reference</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> +<dd class="field-even"><p>no</p> </dd> </dl> <p>The ebuild code must be fully contained within .ebuild and .eclass @@ -163,14 +186,17 @@ the principle of least surprise. It makes the maintenance harder, confuses other developers and tools that do not explicitly account for that possibility, including linting tools.</p> </div> -<div class="section" id="homepage-must-not-contain-variables"> -<span id="index-2"></span><h2>HOMEPAGE must not contain variables<a class="headerlink" href="#homepage-must-not-contain-variables" title="Permalink to this headline">¶</a></h2> +<div class="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> <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>0103</p> </dd> -<dt class="field-even">Reported</dt> -<dd class="field-even"><p>by pkgcheck, highlighted as error by gentoo-syntax</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, highlighted as error by gentoo-syntax</p> </dd> </dl> <p>The <code class="docutils literal notranslate"><span class="pre">HOMEPAGE</span></code> variable in ebuild must specify all the URIs verbatim, @@ -182,14 +208,17 @@ there. On the other hand, variables render the URIs unusable without preprocessing, breaking URI support in terminals and editors, as well as reducing the usefulness of plain tools such as grep.</p> </div> -<div class="section" id="src-uri-must-not-refer-to-homepage"> -<span id="index-3"></span><h2>SRC_URI must not refer to HOMEPAGE<a class="headerlink" href="#src-uri-must-not-refer-to-homepage" title="Permalink to this headline">¶</a></h2> +<div class="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> <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>0104</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>The <code class="docutils literal notranslate"><span class="pre">SRC_URI</span></code> variable in ebuild must not refer to <code class="docutils literal notranslate"><span class="pre">${HOMEPAGE}</span></code>. @@ -202,6 +231,27 @@ goes against the principle of least surprise. Furthermore, it makes it hard to copy-paste part of the URI e.g. to investigate the directory index.</p> </div> +<div class="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> +<dl class="field-list simple"> +<dt class="field-odd">PG</dt> +<dd class="field-odd"><p>0105</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">KEYWORDS</span></code> variable must be defined at most once in an ebuild, +on a single line, with literal content (no variable references, line +wrapping, appending, etc.).</p> +<p><em>Rationale</em>: it is common for arch teams to use the <code class="docutils literal notranslate"><span class="pre">ekeyword</span></code> tool +when working with large number of ebuilds. The tool has only limited +ability to process and modify ebuilds, and therefore developers must +make sure that it works correctly on their ebuilds.</p> +</div> </div> @@ -252,10 +302,11 @@ index.</p> <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="dependencies.html">Dependencies</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Ebuild file format</a><ul class='nav'> -<li class="toctree-l2"><a class="reference internal" href="#coding-style">Coding style</a></li> -<li class="toctree-l2"><a class="reference internal" href="#code-must-be-contained-within-ebuild-and-eclasses">Code must be contained within ebuild and eclasses</a></li> -<li class="toctree-l2"><a class="reference internal" href="#homepage-must-not-contain-variables">HOMEPAGE must not contain variables</a></li> -<li class="toctree-l2"><a class="reference internal" href="#src-uri-must-not-refer-to-homepage">SRC_URI must not refer to HOMEPAGE</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0101">Coding style</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0102">Code must be contained within ebuild and eclasses</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0103">HOMEPAGE must not contain variables</a></li> +<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> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="filesystem.html">File system layout</a></li> @@ -284,7 +335,7 @@ index.</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> diff --git a/filesystem.html b/filesystem.html index 92860f5..2d3db1d 100644 --- a/filesystem.html +++ b/filesystem.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="Installed files" href="installed-files.html" /> @@ -76,8 +76,25 @@ <li class=""><a href="_sources/filesystem.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="file-system-layout"> <h1>File system layout<a class="headerlink" href="#file-system-layout" title="Permalink to this headline">¶</a></h1> -<div class="section" id="installation-paths"> -<span id="index-0"></span><h2>Installation paths<a class="headerlink" href="#installation-paths" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0201"> +<span id="installation-paths"></span><span id="index-0"></span><h2>Installation paths<a class="headerlink" href="#pg0201" 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>0201</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://gitweb.gentoo.org/repo/gentoo.git/tree/metadata/install-qa-check.d/08gentoo-paths">https://gitweb.gentoo.org/repo/gentoo.git/tree/metadata/install-qa-check.d/08gentoo-paths</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>via install-qa-check.d</p> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://gitweb.gentoo.org/repo/gentoo.git/tree/metadata/install-qa-check.d/08gentoo-paths">https://gitweb.gentoo.org/repo/gentoo.git/tree/metadata/install-qa-check.d/08gentoo-paths</a></p> +</dd> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>via install-qa-check.d</p> </dd> </dl> <p>Gentoo packages may only install into one of the following top-level @@ -181,18 +201,21 @@ exceptions are:</p> <li><p>/nix for the nix package manager</p></li> </ul> </div> -<div class="section" id="support-for-separate-usr"> -<span id="index-1"></span><h2>Support for separate /usr<a class="headerlink" href="#support-for-separate-usr" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0202"> +<span id="support-for-separate-usr"></span><span id="index-1"></span><h2>Support for separate /usr<a class="headerlink" href="#pg0202" 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>0202</p> +</dd> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>QA</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://projects.gentoo.org/council/meeting-logs/20130813-summary.txt">https://projects.gentoo.org/council/meeting-logs/20130813-summary.txt</a> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://projects.gentoo.org/council/meeting-logs/20130813-summary.txt">https://projects.gentoo.org/council/meeting-logs/20130813-summary.txt</a> <a class="reference external" href="https://projects.gentoo.org/council/meeting-logs/20130924-summary.txt">https://projects.gentoo.org/council/meeting-logs/20130924-summary.txt</a></p> </dd> -<dt class="field-odd">Reported</dt> -<dd class="field-odd"><p>no</p> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>no</p> </dd> </dl> <p>Developers are not required to support using separate /usr filesystem @@ -203,17 +226,20 @@ works, it is either subtly broken or relying on hacks (udev). In setups using initramfs, some of the boot and repair functionality can be moved from rootfs to initramfs.</p> </div> -<div class="section" id="strict-multilib-layout"> -<span id="index-2"></span><h2>Strict multilib layout<a class="headerlink" href="#strict-multilib-layout" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0203"> +<span id="strict-multilib-layout"></span><span id="index-2"></span><h2>Strict multilib layout<a class="headerlink" href="#pg0203" 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>0203</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80multilib-strict">https://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80multilib-strict</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>via install-qa-check.d, fatal</p> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80multilib-strict">https://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80multilib-strict</a></p> +</dd> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>via install-qa-check.d, fatal</p> </dd> </dl> <p>Libraries must be installed into an appropriate /lib* or /usr/lib* @@ -227,17 +253,20 @@ path. With modern Gentoo profiles, this is no longer the case and packages must install libraries into appropriate directory for them to be correctly found by the dynamic loader.</p> </div> -<div class="section" id="static-libraries-and-libtool-files"> -<span id="index-3"></span><h2>Static libraries and libtool files<a class="headerlink" href="#static-libraries-and-libtool-files" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0204"> +<span id="static-libraries-and-libtool-files"></span><span id="index-3"></span><h2>Static libraries and libtool files<a class="headerlink" href="#pg0204" 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>0204</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80libraries">https://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80libraries</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>via install-qa-check.d, fatal</p> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80libraries">https://gitweb.gentoo.org/proj/portage.git/tree/bin/install-qa-check.d/80libraries</a></p> +</dd> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>via install-qa-check.d, fatal</p> </dd> </dl> <p>Static libraries and libtool files (.la) must be installed into /usr @@ -250,18 +279,21 @@ installations may still use small / partition. Static libraries are used only during package builds, and installing them to rootfs would be a waste of space.</p> </div> -<div class="section" id="game-install-locations-and-ownership"> -<span id="index-4"></span><h2>Game install locations and ownership<a class="headerlink" href="#game-install-locations-and-ownership" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0205"> +<span id="game-install-locations-and-ownership"></span><span id="index-4"></span><h2>Game install locations and ownership<a class="headerlink" href="#pg0205" title="Permalink to this headline">¶</a></h2> <dl class="field-list simple"> -<dt class="field-odd">Source</dt> -<dd class="field-odd"><p>Council, clarified by QA</p> +<dt class="field-odd">PG</dt> +<dd class="field-odd"><p>0205</p> +</dd> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>Council, clarified by QA</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://projects.gentoo.org/council/meeting-logs/20151213-summary.txt">https://projects.gentoo.org/council/meeting-logs/20151213-summary.txt</a> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://projects.gentoo.org/council/meeting-logs/20151213-summary.txt">https://projects.gentoo.org/council/meeting-logs/20151213-summary.txt</a> <a class="reference external" href="https://projects.gentoo.org/council/meeting-logs/20151011-summary.txt">https://projects.gentoo.org/council/meeting-logs/20151011-summary.txt</a></p> </dd> -<dt class="field-odd">Reported</dt> -<dd class="field-odd"><p>via install-qa-check.d</p> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>via install-qa-check.d</p> </dd> </dl> <p>The historical game install locations (/usr/games and /etc/games) must @@ -286,14 +318,17 @@ share data files. Since the latter implied users must not be added to the games group, a new group (gamestat) needed to be created to fulfill that purpose.</p> </div> -<div class="section" id="absolute-symbolic-link-targets"> -<span id="index-5"></span><h2>Absolute symbolic link targets<a class="headerlink" href="#absolute-symbolic-link-targets" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0206"> +<span id="absolute-symbolic-link-targets"></span><span id="index-5"></span><h2>Absolute symbolic link targets<a class="headerlink" href="#pg0206" 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>0206</p> </dd> -<dt class="field-even">Reported</dt> -<dd class="field-even"><p>by repoman and pkgcheck (when ebuild-generated)</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 repoman and pkgcheck (when ebuild-generated)</p> </dd> </dl> <p>Packages must not install symbolic links with absolute targets. @@ -364,12 +399,12 @@ it is mounted in another location, e.g. for the purposes of recovery.</p> <li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li> <li class="toctree-l1"><a class="reference internal" href="ebuild-format.html">Ebuild file format</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">File system layout</a><ul class='nav'> -<li class="toctree-l2"><a class="reference internal" href="#installation-paths">Installation paths</a></li> -<li class="toctree-l2"><a class="reference internal" href="#support-for-separate-usr">Support for separate /usr</a></li> -<li class="toctree-l2"><a class="reference internal" href="#strict-multilib-layout">Strict multilib layout</a></li> -<li class="toctree-l2"><a class="reference internal" href="#static-libraries-and-libtool-files">Static libraries and libtool files</a></li> -<li class="toctree-l2"><a class="reference internal" href="#game-install-locations-and-ownership">Game install locations and ownership</a></li> -<li class="toctree-l2"><a class="reference internal" href="#absolute-symbolic-link-targets">Absolute symbolic link targets</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0201">Installation paths</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0202">Support for separate /usr</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0203">Strict multilib layout</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0204">Static libraries and libtool files</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0205">Game install locations and ownership</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0206">Absolute symbolic link targets</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="installed-files.html">Installed files</a></li> @@ -397,7 +432,7 @@ it is mounted in another location, e.g. for the purposes of recovery.</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> diff --git a/genindex.html b/genindex.html index a16717e..4bc176a 100644 --- a/genindex.html +++ b/genindex.html @@ -16,10 +16,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="#" /> <link rel="search" title="Search" href="search.html" /> </head><body> @@ -75,8 +75,21 @@ <li class=""><a href="https://gitweb.gentoo.org/proj/policy-guide.git/">Source</a></li> <li> <a href="search.html">Search</a></li> + + <li class="active"> - <a href="genindex.html">Index</a></li> + + <a href="genindex.html">General Index</a> + + </li> + + <li> + + <a href="std-policy-index.html">Policy Index</a> + + </li> + + @@ -289,6 +302,8 @@ keywords <ul> + <li><a href="ebuild-format.html#index-4">one line</a> +</li> <li><a href="keywords.html#index-0">rekeywording</a> </li> <li><a href="keywords.html#index-2">removing stable</a> @@ -312,6 +327,10 @@ </li> </ul></li> </ul></td> + <td style="width: 33%; vertical-align: top;"><ul> + <li><a href="other-metadata.html#index-4">license</a> +</li> + </ul></td> </tr></table> <h2 id="M">M</h2> @@ -492,7 +511,7 @@ <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> @@ -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="Preface" href="preface.html" /> @@ -75,8 +75,23 @@ <li class=""><a href="_sources/index.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> + + + + @@ -157,77 +172,79 @@ in which the policy can be updated.</p> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a><ul> -<li class="toctree-l2"><a class="reference internal" href="dependencies.html#optional-runtime-dependencies">Optional runtime dependencies</a></li> -<li class="toctree-l2"><a class="reference internal" href="dependencies.html#dependencies-with-no-revision">=-dependencies with no revision</a></li> +<li class="toctree-l2"><a class="reference internal" href="dependencies.html#pg0001">Optional runtime dependencies</a></li> +<li class="toctree-l2"><a class="reference internal" href="dependencies.html#pg0002">=-dependencies with no revision</a></li> <li class="toctree-l2"><a class="reference internal" href="dependencies.html#slot-and-subslot-dependencies">Slot and subslot dependencies</a><ul> -<li class="toctree-l3"><a class="reference internal" href="dependencies.html#on-sub-slotted-packages">on (sub-)slotted packages</a></li> -<li class="toctree-l3"><a class="reference internal" href="dependencies.html#special-case-qt-packages">special case: Qt packages</a></li> +<li class="toctree-l3"><a class="reference internal" href="dependencies.html#pg0011">on (sub-)slotted packages</a></li> +<li class="toctree-l3"><a class="reference internal" href="dependencies.html#pg0012">special case: Qt packages</a></li> <li class="toctree-l3"><a class="reference internal" href="dependencies.html#proactive-use-of-slot-operators">proactive use of slot operators</a></li> </ul> </li> -<li class="toctree-l2"><a class="reference internal" href="dependencies.html#revision-bumps-on-runtime-dependency-changes">Revision bumps on runtime dependency changes</a></li> +<li class="toctree-l2"><a class="reference internal" href="dependencies.html#pg0003">Revision bumps on runtime dependency changes</a></li> <li class="toctree-l2"><a class="reference internal" href="dependencies.html#use-dependencies">USE dependencies</a><ul> -<li class="toctree-l3"><a class="reference internal" href="dependencies.html#on-packages-without-the-flag">on packages without the flag</a></li> +<li class="toctree-l3"><a class="reference internal" href="dependencies.html#pg0021">on packages without the flag</a></li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="ebuild-format.html">Ebuild file format</a><ul> -<li class="toctree-l2"><a class="reference internal" href="ebuild-format.html#coding-style">Coding style</a></li> -<li class="toctree-l2"><a class="reference internal" href="ebuild-format.html#code-must-be-contained-within-ebuild-and-eclasses">Code must be contained within ebuild and eclasses</a></li> -<li class="toctree-l2"><a class="reference internal" href="ebuild-format.html#homepage-must-not-contain-variables">HOMEPAGE must not contain variables</a></li> -<li class="toctree-l2"><a class="reference internal" href="ebuild-format.html#src-uri-must-not-refer-to-homepage">SRC_URI must not refer to HOMEPAGE</a></li> +<li class="toctree-l2"><a class="reference internal" href="ebuild-format.html#pg0101">Coding style</a></li> +<li class="toctree-l2"><a class="reference internal" href="ebuild-format.html#pg0102">Code must be contained within ebuild and eclasses</a></li> +<li class="toctree-l2"><a class="reference internal" href="ebuild-format.html#pg0103">HOMEPAGE must not contain variables</a></li> +<li class="toctree-l2"><a class="reference internal" href="ebuild-format.html#pg0104">SRC_URI must not refer to HOMEPAGE</a></li> +<li class="toctree-l2"><a class="reference internal" href="ebuild-format.html#pg0105">KEYWORDS must be defined on a single line</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="filesystem.html">File system layout</a><ul> -<li class="toctree-l2"><a class="reference internal" href="filesystem.html#installation-paths">Installation paths</a></li> -<li class="toctree-l2"><a class="reference internal" href="filesystem.html#support-for-separate-usr">Support for separate /usr</a></li> -<li class="toctree-l2"><a class="reference internal" href="filesystem.html#strict-multilib-layout">Strict multilib layout</a></li> -<li class="toctree-l2"><a class="reference internal" href="filesystem.html#static-libraries-and-libtool-files">Static libraries and libtool files</a></li> -<li class="toctree-l2"><a class="reference internal" href="filesystem.html#game-install-locations-and-ownership">Game install locations and ownership</a></li> -<li class="toctree-l2"><a class="reference internal" href="filesystem.html#absolute-symbolic-link-targets">Absolute symbolic link targets</a></li> +<li class="toctree-l2"><a class="reference internal" href="filesystem.html#pg0201">Installation paths</a></li> +<li class="toctree-l2"><a class="reference internal" href="filesystem.html#pg0202">Support for separate /usr</a></li> +<li class="toctree-l2"><a class="reference internal" href="filesystem.html#pg0203">Strict multilib layout</a></li> +<li class="toctree-l2"><a class="reference internal" href="filesystem.html#pg0204">Static libraries and libtool files</a></li> +<li class="toctree-l2"><a class="reference internal" href="filesystem.html#pg0205">Game install locations and ownership</a></li> +<li class="toctree-l2"><a class="reference internal" href="filesystem.html#pg0206">Absolute symbolic link targets</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="installed-files.html">Installed files</a><ul> -<li class="toctree-l2"><a class="reference internal" href="installed-files.html#installation-of-small-files">Installation of small files</a></li> -<li class="toctree-l2"><a class="reference internal" href="installed-files.html#installation-of-static-libraries">Installation of static libraries</a></li> -<li class="toctree-l2"><a class="reference internal" href="installed-files.html#installation-of-libtool-la-files">Installation of libtool (.la) files</a></li> +<li class="toctree-l2"><a class="reference internal" href="installed-files.html#pg0301">Installation of small files</a></li> +<li class="toctree-l2"><a class="reference internal" href="installed-files.html#pg0302">Installation of static libraries</a></li> +<li class="toctree-l2"><a class="reference internal" href="installed-files.html#pg0303">Installation of libtool (.la) files</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="keywords.html">Keywording and stabilization</a><ul> -<li class="toctree-l2"><a class="reference internal" href="keywords.html#rekeywording-on-dropped-keywords">Rekeywording on dropped keywords</a></li> -<li class="toctree-l2"><a class="reference internal" href="keywords.html#stabilizing-new-versions">Stabilizing new versions</a></li> -<li class="toctree-l2"><a class="reference internal" href="keywords.html#removing-stable-keywords">Removing stable keywords</a></li> +<li class="toctree-l2"><a class="reference internal" href="keywords.html#pg0401">Rekeywording on dropped keywords</a></li> +<li class="toctree-l2"><a class="reference internal" href="keywords.html#pg0402">Stabilizing new versions</a></li> +<li class="toctree-l2"><a class="reference internal" href="keywords.html#pg0403">Removing stable keywords</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="languages.html">Language-specific policies</a><ul> <li class="toctree-l2"><a class="reference internal" href="languages.html#python">Python</a><ul> -<li class="toctree-l3"><a class="reference internal" href="languages.html#eclass-usage">Eclass usage</a></li> -<li class="toctree-l3"><a class="reference internal" href="languages.html#python-2-deprecation">Python 2 deprecation</a></li> +<li class="toctree-l3"><a class="reference internal" href="languages.html#pg0501">Eclass usage</a></li> +<li class="toctree-l3"><a class="reference internal" href="languages.html#pg0502">Python 2 deprecation</a></li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="maintainer.html">Package Maintainers</a><ul> -<li class="toctree-l2"><a class="reference internal" href="maintainer.html#adding-new-maintainers">Adding new maintainers</a></li> -<li class="toctree-l2"><a class="reference internal" href="maintainer.html#new-packages-without-a-maintainer">New packages without a maintainer</a></li> -<li class="toctree-l2"><a class="reference internal" href="maintainer.html#removing-package-maintainers">Removing package maintainers</a></li> +<li class="toctree-l2"><a class="reference internal" href="maintainer.html#pg0601">Adding new maintainers</a></li> +<li class="toctree-l2"><a class="reference internal" href="maintainer.html#pg0602">New packages without a maintainer</a></li> +<li class="toctree-l2"><a class="reference internal" href="maintainer.html#pg0603">Removing package maintainers</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="other-metadata.html">Other metadata variables</a><ul> -<li class="toctree-l2"><a class="reference internal" href="other-metadata.html#dynamic-slots-multislot-flag">Dynamic slots (multislot flag)</a></li> -<li class="toctree-l2"><a class="reference internal" href="other-metadata.html#homepage-value-must-be-meaningful">HOMEPAGE value must be meaningful</a></li> -<li class="toctree-l2"><a class="reference internal" href="other-metadata.html#restrict-test-for-use-test">RESTRICT=test for USE=-test</a></li> +<li class="toctree-l2"><a class="reference internal" href="other-metadata.html#pg0701">Dynamic slots (multislot flag)</a></li> +<li class="toctree-l2"><a class="reference internal" href="other-metadata.html#pg0702">HOMEPAGE value must be meaningful</a></li> +<li class="toctree-l2"><a class="reference internal" href="other-metadata.html#pg0703">RESTRICT=test for USE=-test</a></li> +<li class="toctree-l2"><a class="reference internal" href="other-metadata.html#pg0704">LICENSE</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="use-flags.html">USE flags</a><ul> -<li class="toctree-l2"><a class="reference internal" href="use-flags.html#versioned-use-flags">Versioned USE flags</a></li> -<li class="toctree-l2"><a class="reference internal" href="use-flags.html#use-gui-flag">USE=gui flag</a></li> -<li class="toctree-l2"><a class="reference internal" href="use-flags.html#underscores-in-use-flag-names">Underscores in USE flag names</a></li> +<li class="toctree-l2"><a class="reference internal" href="use-flags.html#pg0801">Versioned USE flags</a></li> +<li class="toctree-l2"><a class="reference internal" href="use-flags.html#pg0802">USE=gui flag</a></li> +<li class="toctree-l2"><a class="reference internal" href="use-flags.html#pg0803">Underscores in USE flag names</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="user-group.html">Users and groups</a><ul> -<li class="toctree-l2"><a class="reference internal" href="user-group.html#user-and-group-account-policy">User and group account policy</a></li> +<li class="toctree-l2"><a class="reference internal" href="user-group.html#pg0901">User and group account policy</a></li> </ul> </li> </ul> @@ -308,7 +325,7 @@ in which the policy can be updated.</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> diff --git a/installed-files.html b/installed-files.html index 66d4b35..0bb4cac 100644 --- a/installed-files.html +++ b/installed-files.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="Keywording and stabilization" href="keywords.html" /> @@ -76,8 +76,25 @@ <li class=""><a href="_sources/installed-files.rst.txt">Source</a></li> <li> <a href="search.html">Search</a></li> + + <li> - <a href="genindex.html">Index</a></li> + + <a href="genindex.html">General Index</a> + + </li> + + <li> + + <a href="std-policy-index.html">Policy Index</a> + + </li> + + + + + + @@ -115,14 +132,17 @@ <div class="section" id="installed-files"> <h1>Installed files<a class="headerlink" href="#installed-files" title="Permalink to this headline">¶</a></h1> -<div class="section" id="installation-of-small-files"> -<span id="index-0"></span><h2>Installation of small files<a class="headerlink" href="#installation-of-small-files" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0301"> +<span id="installation-of-small-files"></span><span id="index-0"></span><h2>Installation of small files<a class="headerlink" href="#pg0301" 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>0301</p> </dd> -<dt class="field-even">Reported</dt> -<dd class="field-even"><p>no</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>no</p> </dd> </dl> <p>Ebuilds must not introduce USE flags to control installing files that @@ -147,14 +167,17 @@ if he wishes to use completions in the first place, and if it is not installed, completion files are not used at all.</p> </div> </div> -<div class="section" id="installation-of-static-libraries"> -<span id="index-1"></span><h2>Installation of static libraries<a class="headerlink" href="#installation-of-static-libraries" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0302"> +<span id="installation-of-static-libraries"></span><span id="index-1"></span><h2>Installation of static libraries<a class="headerlink" href="#pg0302" 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>0302</p> +</dd> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>QA</p> </dd> -<dt class="field-even">Reported</dt> -<dd class="field-even"><p>no</p> +<dt class="field-odd">Reported</dt> +<dd class="field-odd"><p>no</p> </dd> </dl> <p>Packages must not install static libraries unless they are explicitly @@ -168,14 +191,17 @@ 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> -<div class="section" id="installation-of-libtool-la-files"> -<span id="index-2"></span><h2>Installation of libtool (.la) files<a class="headerlink" href="#installation-of-libtool-la-files" title="Permalink to this headline">¶</a></h2> +<div class="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 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>0303</p> +</dd> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>QA</p> </dd> -<dt class="field-even">Reported</dt> -<dd class="field-even"><p>no</p> +<dt class="field-odd">Reported</dt> +<dd class="field-odd"><p>no</p> </dd> </dl> <p>Packages must not install libtool .la files unless they are explicitly @@ -251,9 +277,9 @@ unnecessary and potentially harmful.</p> <li class="toctree-l1"><a class="reference internal" href="ebuild-format.html">Ebuild file format</a></li> <li class="toctree-l1"><a class="reference internal" href="filesystem.html">File system layout</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Installed files</a><ul class='nav'> -<li class="toctree-l2"><a class="reference internal" href="#installation-of-small-files">Installation of small files</a></li> -<li class="toctree-l2"><a class="reference internal" href="#installation-of-static-libraries">Installation of static libraries</a></li> -<li class="toctree-l2"><a class="reference internal" href="#installation-of-libtool-la-files">Installation of libtool (.la) files</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0301">Installation of small files</a></li> +<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> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="keywords.html">Keywording and stabilization</a></li> @@ -280,7 +306,7 @@ unnecessary and potentially harmful.</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> diff --git a/keywords.html b/keywords.html index a53fff7..77e7e15 100644 --- a/keywords.html +++ b/keywords.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="Language-specific policies" href="languages.html" /> @@ -76,8 +76,25 @@ <li class=""><a href="_sources/keywords.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,14 +132,17 @@ <div class="section" id="keywording-and-stabilization"> <h1>Keywording and stabilization<a class="headerlink" href="#keywording-and-stabilization" title="Permalink to this headline">¶</a></h1> -<div class="section" id="rekeywording-on-dropped-keywords"> -<span id="index-0"></span><h2>Rekeywording on dropped keywords<a class="headerlink" href="#rekeywording-on-dropped-keywords" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0401"> +<span id="rekeywording-on-dropped-keywords"></span><span id="index-0"></span><h2>Rekeywording on dropped keywords<a class="headerlink" href="#pg0401" 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>0401</p> </dd> -<dt class="field-even">Reported</dt> -<dd class="field-even"><p>by pkgcheck and repoman</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 and repoman</p> </dd> </dl> <p>The developer removing keywords from a package (e.g. due to new @@ -134,14 +154,17 @@ time. If a developer neglects to request it immediately, it negatively affects other developers who in the future either want to stabilize a new version or to remove an old version.</p> </div> -<div class="section" id="stabilizing-new-versions"> -<span id="index-1"></span><h2>Stabilizing new versions<a class="headerlink" href="#stabilizing-new-versions" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0402"> +<span id="stabilizing-new-versions"></span><span id="index-1"></span><h2>Stabilizing new versions<a class="headerlink" href="#pg0402" 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>0402</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 requesting a stabilization of a new version of the package, @@ -161,17 +184,20 @@ a duplication of effort and unnecessary confusion over which version is stable and whether arch teams are slacking or stabilization was not requested on remaining architectures in the first place.</p> </div> -<div class="section" id="removing-stable-keywords"> -<span id="index-2"></span><h2>Removing stable keywords<a class="headerlink" href="#removing-stable-keywords" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0403"> +<span id="removing-stable-keywords"></span><span id="index-2"></span><h2>Removing stable keywords<a class="headerlink" href="#pg0403" 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>0403</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=126033#Dropping_Stable_KEYWORDs">https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=126033#Dropping_Stable_KEYWORDs</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>n/a</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=126033#Dropping_Stable_KEYWORDs">https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=126033#Dropping_Stable_KEYWORDs</a></p> +</dd> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>n/a</p> </dd> </dl> <p>Stable keywords (or the last stable version) can be removed from @@ -235,9 +261,9 @@ of last rite mails.</p> <li class="toctree-l1"><a class="reference internal" href="filesystem.html">File system layout</a></li> <li class="toctree-l1"><a class="reference internal" href="installed-files.html">Installed files</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Keywording and stabilization</a><ul class='nav'> -<li class="toctree-l2"><a class="reference internal" href="#rekeywording-on-dropped-keywords">Rekeywording on dropped keywords</a></li> -<li class="toctree-l2"><a class="reference internal" href="#stabilizing-new-versions">Stabilizing new versions</a></li> -<li class="toctree-l2"><a class="reference internal" href="#removing-stable-keywords">Removing stable keywords</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0401">Rekeywording on dropped keywords</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0402">Stabilizing new versions</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0403">Removing stable keywords</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="languages.html">Language-specific policies</a></li> @@ -263,7 +289,7 @@ of last rite mails.</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> diff --git a/languages.html b/languages.html index c28e43f..665fdab 100644 --- a/languages.html +++ b/languages.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="Package Maintainers" href="maintainer.html" /> @@ -76,8 +76,25 @@ <li class=""><a href="_sources/languages.rst.txt">Source</a></li> <li> <a href="search.html">Search</a></li> + + <li> - <a href="genindex.html">Index</a></li> + + <a href="genindex.html">General Index</a> + + </li> + + <li> + + <a href="std-policy-index.html">Policy Index</a> + + </li> + + + + + + @@ -117,17 +134,20 @@ <h1>Language-specific policies<a class="headerlink" href="#language-specific-policies" title="Permalink to this headline">¶</a></h1> <div class="section" id="python"> <span id="index-0"></span><h2>Python<a class="headerlink" href="#python" title="Permalink to this headline">¶</a></h2> -<span class="target" id="index-1"></span><span class="target" id="index-2"></span><span class="target" id="index-3"></span><div class="section" id="eclass-usage"> -<span id="index-4"></span><h3>Eclass usage<a class="headerlink" href="#eclass-usage" title="Permalink to this headline">¶</a></h3> +<span class="target" id="index-1"></span><span class="target" id="index-2"></span><span class="target" id="index-3"></span><div class="section" id="pg0501"> +<span id="eclass-usage"></span><span id="index-4"></span><h3>Eclass usage<a class="headerlink" href="#pg0501" title="Permalink to this headline">¶</a></h3> <dl class="field-list simple"> -<dt class="field-odd">Source</dt> -<dd class="field-odd"><p>Python project</p> +<dt class="field-odd">PG</dt> +<dd class="field-odd"><p>0501</p> +</dd> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>Python project</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://wiki.gentoo.org/wiki/Project:Python/Eclasses">https://wiki.gentoo.org/wiki/Project:Python/Eclasses</a></p> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://wiki.gentoo.org/wiki/Project:Python/Eclasses">https://wiki.gentoo.org/wiki/Project:Python/Eclasses</a></p> </dd> -<dt class="field-odd">Reported</dt> -<dd class="field-odd"><p>by pkgcheck</p> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>by pkgcheck</p> </dd> </dl> <p>All packages using Python (either through installing Python modules @@ -147,17 +167,20 @@ if user changes his Python preferences. The helper functions and variables also make it possible to gracefully retire old implementations with minimal changes to existing ebuilds.</p> </div> -<div class="section" id="python-2-deprecation"> -<span id="index-5"></span><h3>Python 2 deprecation<a class="headerlink" href="#python-2-deprecation" title="Permalink to this headline">¶</a></h3> +<div class="section" id="pg0502"> +<span id="python-2-deprecation"></span><span id="index-5"></span><h3>Python 2 deprecation<a class="headerlink" href="#pg0502" title="Permalink to this headline">¶</a></h3> <dl class="field-list simple"> -<dt class="field-odd">Source</dt> -<dd class="field-odd"><p>Python project</p> +<dt class="field-odd">PG</dt> +<dd class="field-odd"><p>0502</p> +</dd> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>Python project</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://wiki.gentoo.org/wiki/Project:Python#Python_2_end-of-life">https://wiki.gentoo.org/wiki/Project:Python#Python_2_end-of-life</a></p> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://wiki.gentoo.org/wiki/Project:Python#Python_2_end-of-life">https://wiki.gentoo.org/wiki/Project:Python#Python_2_end-of-life</a></p> </dd> -<dt class="field-odd">Reported</dt> -<dd class="field-odd"><p>no</p> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>no</p> </dd> </dl> <p>Python 2 is being phased out of Gentoo packages. Python 2 support @@ -234,8 +257,8 @@ will cause major upgrade issues.</p> <li class="toctree-l1"><a class="reference internal" href="keywords.html">Keywording and stabilization</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Language-specific policies</a><ul class='nav'> <li class="toctree-l2"><a class="reference internal" href="#python">Python</a><ul class='nav'> -<li class="toctree-l3"><a class="reference internal" href="#eclass-usage">Eclass usage</a></li> -<li class="toctree-l3"><a class="reference internal" href="#python-2-deprecation">Python 2 deprecation</a></li> +<li class="toctree-l3"><a class="reference internal" href="#pg0501">Eclass usage</a></li> +<li class="toctree-l3"><a class="reference internal" href="#pg0502">Python 2 deprecation</a></li> </ul> </li> </ul> @@ -262,7 +285,7 @@ will cause major upgrade issues.</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> diff --git a/maintainer.html b/maintainer.html index 5caec5e..48daae6 100644 --- a/maintainer.html +++ b/maintainer.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="Other metadata variables" href="other-metadata.html" /> @@ -76,8 +76,25 @@ <li class=""><a href="_sources/maintainer.rst.txt">Source</a></li> <li> <a href="search.html">Search</a></li> + + <li> - <a href="genindex.html">Index</a></li> + + <a href="genindex.html">General Index</a> + + </li> + + <li> + + <a href="std-policy-index.html">Policy Index</a> + + </li> + + + + + + @@ -115,14 +132,17 @@ <div class="section" id="package-maintainers"> <h1>Package Maintainers<a class="headerlink" href="#package-maintainers" title="Permalink to this headline">¶</a></h1> -<div class="section" id="adding-new-maintainers"> -<span id="index-0"></span><h2>Adding new maintainers<a class="headerlink" href="#adding-new-maintainers" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0601"> +<span id="adding-new-maintainers"></span><span id="index-0"></span><h2>Adding new maintainers<a class="headerlink" href="#pg0601" 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>0601</p> </dd> -<dt class="field-even">Reported</dt> -<dd class="field-even"><p>no</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>no</p> </dd> </dl> <p>Developers must not add other developers as package maintainers, unless @@ -141,14 +161,17 @@ includes various end-user programs written in Python. Many of those packages ended up being maintained solely by Python, and distinguishing them from packages actually within project’s profile was hard.</p> </div> -<div class="section" id="new-packages-without-a-maintainer"> -<span id="index-1"></span><h2>New packages without a maintainer<a class="headerlink" href="#new-packages-without-a-maintainer" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0602"> +<span id="new-packages-without-a-maintainer"></span><span id="index-1"></span><h2>New packages without a maintainer<a class="headerlink" href="#pg0602" 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>0602</p> +</dd> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>QA</p> </dd> -<dt class="field-even">Reported</dt> -<dd class="field-even"><p>no</p> +<dt class="field-odd">Reported</dt> +<dd class="field-odd"><p>no</p> </dd> </dl> <p>It is explicitly forbidden to add new packages without a dedicated @@ -160,14 +183,17 @@ trying to fix them as necessary. It is unfair and inappropriate to increase their maintenance burden by adding new packages and refusing to take care of them.</p> <span class="target" id="index-2"></span></div> -<div class="section" id="removing-package-maintainers"> -<span id="index-3"></span><h2>Removing package maintainers<a class="headerlink" href="#removing-package-maintainers" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0603"> +<span id="removing-package-maintainers"></span><span id="index-3"></span><h2>Removing package maintainers<a class="headerlink" href="#pg0603" 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>0603</p> +</dd> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>QA</p> </dd> -<dt class="field-even">Reported</dt> -<dd class="field-even"><p>no</p> +<dt class="field-odd">Reported</dt> +<dd class="field-odd"><p>no</p> </dd> </dl> <p>When removing maintainers from a package, the developer must reassign @@ -243,9 +269,9 @@ to them silently becoming maintainer-needed).</p> <li class="toctree-l1"><a class="reference internal" href="keywords.html">Keywording and stabilization</a></li> <li class="toctree-l1"><a class="reference internal" href="languages.html">Language-specific policies</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Package Maintainers</a><ul class='nav'> -<li class="toctree-l2"><a class="reference internal" href="#adding-new-maintainers">Adding new maintainers</a></li> -<li class="toctree-l2"><a class="reference internal" href="#new-packages-without-a-maintainer">New packages without a maintainer</a></li> -<li class="toctree-l2"><a class="reference internal" href="#removing-package-maintainers">Removing package maintainers</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0601">Adding new maintainers</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0602">New packages without a maintainer</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0603">Removing package maintainers</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="other-metadata.html">Other metadata variables</a></li> @@ -269,7 +295,7 @@ to them silently becoming maintainer-needed).</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> diff --git a/motivation.html b/motivation.html index 28eb98a..94c96b1 100644 --- a/motivation.html +++ b/motivation.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="Basic information" href="basics.html" /> @@ -76,8 +76,25 @@ <li class=""><a href="_sources/motivation.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> + + + + + + @@ -238,7 +255,7 @@ devmanual) should conform to policies stated here.</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> diff --git a/other-docs.html b/other-docs.html index 43473bf..a5d169c 100644 --- a/other-docs.html +++ b/other-docs.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="Dependencies" href="dependencies.html" /> @@ -76,8 +76,25 @@ <li class=""><a href="_sources/other-docs.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> + + + + + + @@ -251,7 +268,7 @@ disagree, Gentoo policies should be followed.</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> 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> diff --git a/preface.html b/preface.html index f144a71..4721546 100644 --- a/preface.html +++ b/preface.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="Motivation and history" href="motivation.html" /> @@ -76,8 +76,29 @@ <li class=""><a href="_sources/preface.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="std-policy-index.html">Policy Index</a> + + </li> + + + <li> - <a href="genindex.html">Index</a></li> + + <a href="index.html">Gentoo Policy Guide</a> + + </li> + + @@ -219,7 +240,7 @@ in which the policy can be updated.</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> diff --git a/search.html b/search.html index 8665e88..2b4dac5 100644 --- a/search.html +++ b/search.html @@ -16,14 +16,14 @@ <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 type="text/javascript" src="_static/searchtools.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> + <script src="_static/searchtools.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="#" /> - <script type="text/javascript" src="searchindex.js" defer></script> + <script src="searchindex.js" defer></script> </head><body> @@ -79,8 +79,21 @@ <li class=""><a href="https://gitweb.gentoo.org/proj/policy-guide.git/">Source</a></li> <li class="active"> <a href="search.html">Search</a></li> + + <li> - <a href="genindex.html">Index</a></li> + + <a href="genindex.html">General Index</a> + + </li> + + <li> + + <a href="std-policy-index.html">Policy Index</a> + + </li> + + @@ -118,7 +131,7 @@ <h1 id="search-documentation">Search</h1> <div id="fallback" class="admonition warning"> - <script type="text/javascript">$('#fallback').hide();</script> + <script>$('#fallback').hide();</script> <p> Please activate JavaScript to enable the search functionality. @@ -167,7 +180,7 @@ <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> diff --git a/searchindex.js b/searchindex.js index cc0fb58..04ddb33 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["basics","dependencies","ebuild-format","filesystem","index","installed-files","keywords","languages","maintainer","motivation","other-docs","other-metadata","preface","use-flags","user-group"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":2,sphinx:56},filenames:["basics.rst","dependencies.rst","ebuild-format.rst","filesystem.rst","index.rst","installed-files.rst","keywords.rst","languages.rst","maintainer.rst","motivation.rst","other-docs.rst","other-metadata.rst","preface.rst","use-flags.rst","user-group.rst"],objects:{},objnames:{},objtypes:{},terms:{"08gentoo":3,"2fuse":11,"80librari":3,"80multilib":3,"83cc5bbd7bbe8bdf04dd3c3bc7f8a035":11,"9cae3a92412a007febe7ac0612d50f5f":1,"break":[2,7],"case":[0,3,4,6,11],"class":0,"default":[1,5],"final":[0,9,10],"function":[0,2,3,7],"g\u00f3rny":12,"import":[1,7,14],"long":[1,6,7,11],"micha\u0142":12,"new":[3,4,7,9,13,14],"public":1,"static":4,"switch":13,"true":14,"try":[0,2,8],"var":3,"while":[0,1,2,5,11],Adding:4,FHS:4,For:[1,3,8],Its:[0,9],PMS:[1,9,10,11],Such:[5,11],The:[0,1,2,3,4,6,7,8,9,10,11,12,13,14],There:[1,5,8,9],USE:[4,5],Use:2,Using:1,With:3,_build:[],abi:[1,3],abil:9,abolish:0,about:11,absolut:4,accept:[1,3,11,14],access:3,accident:7,accord:1,account:[1,2,4],acct:14,achiev:0,across:[0,9],action:0,activ:10,actual:8,add:[2,8],added:[3,5,8],adding:[1,8,14],addit:[2,3,5,9,10],addition:0,address:9,adjust:13,adopt:14,advantag:[2,13],affect:[0,2,6],aforement:[3,9],after:[0,1,3],afterward:13,against:[0,2,9],agre:8,aid:14,aim:[0,1,4,8,12,13],align:2,all:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],alloc:14,allow:[2,11],along:[3,9],alreadi:[1,3,7],also:[0,7,9,13],alter:11,alwai:[2,3],amd64:3,amount:9,analyz:0,ani:[1,2,5,8,9,10,11,13],anongit:[],anoth:[1,3,11],anymor:[3,6],anywher:11,api:1,app:5,appeal:4,appli:[0,1,6,8,9,10],applic:[1,3,5,9,10],appropri:3,approv:[1,10,14],arbitrari:14,arch:6,architectur:[0,3,6],archiv:[1,5,11,13],area:0,argu:1,argument:[],aris:[9,13,14],ask:[0,6],assign:[8,14],assum:[1,13],assumpt:11,attach:[],attempt:[2,5,9,13],attribut:12,author:4,autom:0,autotool:5,avail:[1,9,11,13],avoid:[2,5],awar:8,backup:8,bad:[1,3,11],base:5,baselayout:14,bash:[2,5],basic:[4,10],becom:[1,4,8,12],been:[1,3,5,11,13,14],befor:[0,6,13,14],behavior:[0,1,5,11],being:[1,5,6,7,8,11],besid:10,best:[],better:[7,9],between:[3,7,11,13,14],bin:3,bind:[4,9,12],bit:3,blurri:3,bodi:[0,4,9,12],boot:3,both:[0,2,4,5,7,12,13],boundari:3,bracket:2,breakag:[1,6],broken:3,brought:5,browser:3,bug:[2,6,8,11,14],bugzilla:[],build:[0,1,3,5,7,13],built:[],builtin:2,bump:[4,14],burden:8,cach:11,call:[1,7],can:[0,1,3,4,6,9,10,11,12,13,14],care:8,categori:5,caus:[1,5,6,7,11,13],cf3f5a59ac918335766632bd02438722:13,chanc:[7,8],chang:[2,4,7,10],chapter:[],charact:[],check:[1,3,4],checkout:[],choic:[2,13],choos:[11,13],chosen:14,chost:3,circumst:[1,11],claim:1,clarifi:3,clean:1,clear:[4,9,12,13],clone:[],close:6,code:[0,1,4,7,11],collect:9,collis:14,combin:[0,4,9,12],command:[],comment:8,commit:0,common:[1,2,11,12],compar:8,compat:[3,7],compil:0,complet:[5,9],compli:10,complianc:4,compon:0,concept:0,concis:9,condit:2,config:5,conform:[9,10],confus:[2,6,13],consent:8,consequ:5,consid:[5,13],consist:[0,2,7,13],construct:2,contact:0,contain:[4,8,10,13],content:4,context:5,contrari:11,contribut:0,control:[1,3,5,11,13],controlled_optional_rdepend:1,convert:[2,13],copi:2,correct:[1,3],correctli:[0,3],correspond:[1,3],cost:[5,7],could:[5,8,11],council:[0,1,3,4,9,10,12,13],creat:[0,3,9,10,13,14],creativ:12,cross:14,ctarget:3,cumbersom:1,current:[0,3,4,8,12],dai:6,data:3,debat:1,decid:1,decis:[0,9],declar:11,dedic:[8,11],defer:7,defici:9,defin:[1,7,10,13],definit:[4,12],delai:[7,14],depclean:11,depend:[2,4,5,6,7,11,13],dependent_slot:11,deprec:[4,14],design:[2,4,12],desir:14,detail:10,detect:[0,1],dev:[1,3,8,11,13],develop:[0,1,2,3,4,6,8,9,12,13,14],devmanu:[9,10],did:[5,9,11],die:5,differ:[0,1,2],difficult:3,direct:[0,11],directli:[0,7,9],directori:[2,3],disabl:[1,11],disagre:[0,10],disciplinari:0,discourag:[5,13],discov:13,discuss:[10,13],distinguish:[8,13],distribut:[3,10],distro:14,doc:3,document:[0,4,11,12],doe:[1,5,6,8,10,11],done:10,dosym:3,doubt:[0,14],down:[0,9],download:11,downward:14,drop:[4,8],dropping_stable_keyword:6,due:[1,3,5,6],duplic:6,dure:[1,3],dynam:[1,2,3,4,14],each:[0,1,9,11],eapi:10,earli:[3,7],easi:[0,11],easier:[0,13],easili:8,eblit:2,ebuild:[0,1,3,4,5,7,9,10,11],eclass:[1,4,11,14],edit:[2,9],editor:2,educ:0,effort:[0,6],eight:9,either:[1,3,5,6,7,11,13],elog:1,emerg:11,empti:[],enabl:[1,5,11,13],encourag:2,end:[0,7,8,13],enforc:[2,4,10,11],ensur:[1,3,7],entri:[2,14],eprefix:[],equal:1,equival:1,error:[1,2,11],especi:[1,3],establish:9,etc:[0,3],eutil:1,eval:2,even:[1,11,13],everi:9,exampl:[1,3,5,8,11],except:[1,3,6],execut:[0,3,11],exempt:6,exist:[1,7,13,14],expect:0,experi:0,experienc:[0,1],experiment:6,explan:9,explicit:[1,11],explicitli:[1,2,5,7,8,9,11,13,14],exponenti:7,express:13,extend:13,extern:[2,4],fact:1,facto:9,fail:11,fallback:5,far:[0,9],fatal:[3,11],favor:14,featur:[1,11],few:[2,13],file:[0,4,6,8,9],filesystem:[3,10],find:[5,8,9,11],first:[5,6],fit:8,fix:[0,8,14],flag:[0,4,5],flat:[9,13],flip:1,focu:0,focus:[0,9],follow:[0,3,5,6,8,10,14],foo:[1,2],forbidden:[2,8,11],fork:[],form:[2,9,13],formal:9,format:[4,10],former:[1,9],found:[3,9],free:14,frequent:[7,8],frobnic:3,from:[1,2,3,6,8,9,11,14],fulfil:3,full:[3,5],fulli:2,further:[0,14],furthermor:[1,2,3,8,9,11],futur:[1,6,8,10,13,14],game:4,gamestat:3,gap:14,gener:[2,3,5,10,11,13],gentoo:[0,1,2,3,6,7,8,9,11,12,13,14],get:1,gid:14,git:3,github:2,gitweb:3,give:7,glep:[0,1,4,14],global:[4,11,12,13],gnu:3,goal:[4,5],goe:2,going:[5,9],good:[1,3,11,14],govern:0,gp0001:[],grab:8,gracefulli:[7,11],grant:3,graph:[1,6,7],grep:[2,8],group:[3,4,8],grow:7,gtk2:[1,13],gtk3:13,gtk:13,guarante:[7,11],gui:4,guid:[10,12],guidelin:[3,10],guix:3,hack:3,had:[1,6],hand:2,handl:[7,11],hard:[2,8,9,11,13],hardcod:[3,5],harder:2,harm:[5,11],has:[1,3,5,7,11,13,14],have:[1,2,5,6,7,11,14],help:[0,1,2,8],helper:7,here:[5,6,9],hierarch:13,hierarchi:3,high:3,highest:10,highlight:2,his:[0,7],histor:[1,2,3,4,5,11,13,14],histori:4,hold:3,homepag:4,host:3,hour:5,how:[1,9,10],howev:[5,6,9,10,11],html:[],http:[1,2,3,6,7,11,13,14],huge:5,hyphen:13,idea:1,identifi:11,imit:13,immedi:[1,6],immin:14,implement:[0,1,7,10],impli:3,implicitli:1,impos:10,imposs:5,improv:13,inappropri:8,incident:2,includ:[0,1,2,3,5,8,11],inconsist:3,increas:[1,8],indent:2,independ:6,index:[1,2,4,6,11,13],indic:[0,1,3,9,12],individu:2,infer:[1,11],inform:[1,4,8,9,11],initramf:3,instal:[0,1,4,7,11,13],install_mask:5,instead:[1,3,7],instruct:10,intend:9,interchang:1,interest:[6,8],intern:12,introduc:[5,7,13],introduct:[4,13],invalid:11,invari:11,investig:2,involv:0,ish:2,isol:3,issu:[0,5,7,13],its:[1,3,7,9,10],itself:10,ius:11,job:11,justifi:14,keep:5,kept:6,keyword:4,kind:0,knowledg:8,known:[0,6,11],lack:9,languag:4,larg:[8,9],larger:3,last:[6,8],later:7,latexpdf:[],latter:[1,3,9,13],layout:[4,10],lead:14,least:[1,2,6,11],leav:[2,14],lengthen:13,less:[0,2,9],level:[2,3,10],lib64:3,lib:[1,3,5],libbar:1,libexec:3,libfoo:1,libfrobn:1,libpython:7,librari:[1,4],libreoffic:5,libtool:4,licens:4,life:7,like:13,likeli:0,likewis:1,limit:0,line:[],liner:5,link:[1,4,5,7,11],linker:[0,3],lint:[0,2],linux:10,list:[0,3,5,8,9,10,14],littl:[2,11],load:2,loader:[3,5],local:[5,13],locat:[2,4,5,11],log:[1,3,9,13],logic:[1,9],longer:[1,3,8],lose:[1,7],lost:8,lot:9,low:13,lowest:14,made:[3,13],mai:[1,3,5,10,13],mail:[0,6,8,10],maintain:[0,3,4,6,7,9,10,12],mainten:[2,7,8],major:[0,7,10,11,14],make:[1,2,3,4,5,7,8,9,11,13],manag:[0,1,3,4,11],mani:[1,3,5,7,8,10,11],manual:[4,13],marker:11,match:[1,7,14],mean:[1,13],meaning:4,meant:[4,6,8,12],measur:0,meet:[1,3,9,13],member:[0,8],mention:9,mere:8,messag:[1,11,13],metadata:[3,4,8],method:2,mgorni:12,might:5,migrat:14,minim:7,minor:[0,6],mismatch:13,miss:[1,11],mistak:[0,1,11],modern:3,modul:7,moment:1,more:[2,5,9,10,11,13],most:2,motiv:4,mount:3,move:[2,3],mtab:3,much:[5,11],multi:2,multilib:4,multipl:[2,11,13],multislot:4,must:[1,3,4,5,6,7,8,13,14],name:[2,3,4,5],necessari:[1,5,8,13],need:[1,3,5,8,9,10,13,14],needless:1,neg:[5,6],neglect:6,neither:8,never:[3,5,9],nevertheless:10,newest:1,newli:13,next:14,nix:3,no_homepag:11,non:[0,1,2,3,6,9,11],nonfunct:1,nor:[1,8],normal:[3,11],notabl:[],notic:[1,5],number:[7,8,14],obsolet:9,obtain:13,offer:13,often:[6,8],old:[1,3,6,7,8,11],oldid:[1,6,11,13],omit:11,onc:[1,6,8],one:[1,3,5,6,7,8],ones:14,onli:[1,3,5,6,9,10],open:[1,14],oper:[4,10],oppon:1,opportun:1,opt:3,optfeatur:1,option:[4,11,13],order:[0,1,3,5,7,9],org:[1,2,3,6,7,11,13,14],organ:9,origin:[8,9,11],other:[0,1,2,3,4,5,6,7,8,9,12,13],otherwis:[1,5],out:[1,7,8,9,13],output:[],over:[0,6],overlai:11,overlap:2,overrid:[0,10],overspecifi:11,own:3,ownership:4,packag:[0,2,3,4,5,6,7,11,13,14],page:[2,4,9,10],paludi:1,paragraph:[],parallel:11,part:[1,2,3,9],partial:[2,9,10],particular:[5,9],partit:3,past:[2,9],patch:[],path:[0,4,5],per:13,period:0,permit:[1,2,3,8,11],person:[0,6,13],phase:[0,2,7,13],php:[1,6,11,13],pkg:5,pkgcheck:[0,1,2,3,6,7,11,13,14],place:[1,5,6],plain:[1,2],pleas:8,plugin:5,point:[1,3,5,9],pointless:14,polici:[1,5,6,8,11,12,13],port:7,portabl:[0,1,5],portag:[1,3],posix:[2,4],possibl:[0,1,2,7,8,9],potenti:5,practic:[0,5],pre:11,precis:9,predict:1,prefac:4,prefer:[1,7,13],prefix:[],prepar:7,prepend:[],preprocess:2,prerequisit:11,prevent:[1,8,14],previou:[0,1,6],primari:9,primit:14,principl:2,prioriti:13,privat:1,privileg:3,proactiv:4,problem:[0,1],proc:3,proceed:6,process:[4,6,10,12,14],profil:[3,8],program:[5,7,8],proj:3,project:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],prolifer:5,prone:2,propag:1,proper:13,propon:1,propos:1,provid:[0,5,7,9,10,11,14],publish:[],pull:1,purpos:[3,4,11],push:[0,14],pypi:2,python:[4,8],python_2_end:7,python_compat:7,python_gen_cond_dep:7,python_single_target:7,python_single_usedep:7,python_target:7,python_usedep:7,qt4:13,qt5:13,qualiti:0,quality_assur:[1,6,11,13],queri:[9,11],question:[0,1,3,6,8,11],rang:[1,14],rapid:14,rather:[2,9,10,13],rational:[1,2,3,4,5,6,7,8,9,11,12,13,14],reach:7,readabl:3,readi:7,readm:1,realli:[5,9],reason:[1,3,14],reassign:8,rebuild:[1,5],recommend:[2,5,10,13,14],reconsid:1,recoveri:[3,5],reduc:[0,2,7],refer:[1,3,4,6,7,9,11,13,14],refin:1,refus:[0,8],regard:0,regular:[13,14],reject:9,rekeyword:4,rel:3,relat:[0,9],relev:[0,6],reli:[1,3],reliabl:[0,7],remain:6,remov:[1,4,5,7,11,13,14],render:2,repair:3,repeat:[0,2],replac:[5,9,13],repo:3,repoman:[0,1,2,3,6,14],report:[0,1,2,3,5,6,7,8,11,13,14],repositori:[0,9,10,11],request:[0,1,6,14],requir:[1,3,5,7,9,10,11,14],resembl:13,reserv:[13,14],resign:8,resolv:[0,11],respect:[],respond:6,respons:[1,11,13,14],restrict:[1,3,4,9,10],result:[1,14],retest:6,retir:7,reus:14,revers:[1,5,7],review:[10,14],revis:[3,4],risk:0,rite:6,role:0,root:3,rootf:3,rule:[2,6,10,11,13,14],run:[0,3],runtim:[4,7],same:[0,11,14],sbin:3,scale:9,scan:0,scatter:9,scope:11,score:3,script:[3,7],search:4,second:14,section:1,secur:5,select:14,self:3,send:8,sentenc:[],separ:[4,11],serv:14,servic:[0,5],set:[1,2,4,9,12,13],setgid:3,setup:[0,3],share:[3,5],sharealik:12,shell:5,shorter:13,should:[0,1,3,5,6,7,9,10,11,13,14],side:1,silent:8,similar:11,simpl:[13,14],simpli:1,simplifi:14,simultan:11,sinc:[2,3,5,11,13],singl:[2,9,11],site:[],size:5,skip:11,slack:6,slot:[4,7],small:[3,4,8],smaller:5,softwar:[0,3,10],sole:8,solut:1,some:[3,6,9],soon:7,sooner:7,sourc:[1,2,3,4,5,6,7,8,9,11,12,13,14],space:[3,11],span:1,special:[3,4,11,13],specif:[0,1,4,5,9,11,12,13],specifi:[1,2,10,11],spend:5,sphinx:[],spirit:9,split:8,src:3,src_uri:4,srv:3,ssh:[],stabil:4,stabl:[1,4],stale:9,standard:[2,4],start:[1,9,14],state:[3,4,11],still:[1,3,6,13],stop:[],strict:4,strictli:[3,11],strip:5,strongli:5,style:[1,4],sub:4,subdirectori:3,submit:[],subpag:11,subsequ:10,subset:6,subslot:4,subtli:3,success:14,suffer:8,suffici:9,suffix:3,suggest:10,summari:[1,3,13],supplement:[0,5],suppli:[4,12],support:[0,1,2,4,5,7,11,13],suppos:3,sure:8,surpris:[0,2],symbol:4,symlink:3,sync:14,synchron:14,syntax:2,system:[0,4,5,10,14],systemd:[0,5],tab:2,take:[0,1,6,8],target:4,task:0,team:[0,3,4,6,8,9,12,13],technic:[3,5,8,9,10,11,13],tent:1,term:7,termin:2,test:[0,2,4],text:12,than:[0,2,5,7,9,10,13],thei:[0,1,3,5,6,8,11,13],them:[0,3,5,8,9,10,13],themselv:5,therefor:[1,3,4,9,12],thi:[0,1,2,3,5,6,8,9,10,11,12,13,14],those:[0,2,3,7,8,11],three:[0,1],through:[7,10],tild:1,time:[0,1,6,7,9],timefram:1,tini:5,tip:9,titl:[1,6,11,13],todai:5,toggl:1,tool:[0,1,2,5],toolchain:[3,11],toolkit:13,top:3,topic:[],tox:[],tracker:11,tree:[0,3,4,9,10,12],trigger:[0,11],triplet:3,trivial:0,turn:[9,11],two:[0,11],txt:[1,3,13,14],udev:3,uid:14,unclear:9,uncommon:[1,5],uncondition:[5,11],undefin:11,under:[1,11,12],underscor:4,understand:9,unfair:8,unit:[0,5],unless:[1,5,7,8,14],unmaintain:8,unnecessari:[2,5,6,7,13],unnecessarili:[1,13],unpredict:11,unprefix:13,unreli:1,unset:11,until:7,unus:2,unwilling:0,updat:[1,4,9,10,12,14],upgrad:[7,11],upon:10,upstream:[3,7,11],uri:2,usag:[1,4,9],use:[0,2,3,4,5,7,9,11,13,14],use_expand:13,used:[1,2,3,5,7,8,11,13,14],usefulness:2,user:[0,1,3,4,5,7,8,11,13],uses:[1,7,11,13],using:[0,1,2,3,5,7,11,14],usr:4,usual:1,valid:13,valu:[1,2,3,4],variabl:[4,7],variant:3,variou:[0,8,9,13],verbatim:2,veri:[1,3,5,8,9,13,14],verifi:1,version:[1,2,3,4,11,14],versioned_use_flag:13,via:[2,3,9,10,11,13,14],violat:[0,11],virtualenv:[],wai:[1,9,13],want:[6,13],warn:1,wast:3,web:[3,11],well:[2,4,6,9,10,11,12],were:[1,2,5,6,9,11,14],what:8,when:[0,1,2,3,5,8,10,11,13],whenev:[1,2,3,5,6,10,11,13],where:3,whether:[0,1,6],which:[1,2,4,6,9,11,12,13],who:[1,5,6,8,9,13],whole:7,why:8,wide:0,wider:9,widget:13,width:2,wiki:[1,6,7,9,10,11,13],wildcard:1,wish:[5,13],within:[1,3,4,6,8,13],without:[0,2,3,4],word:9,work:[0,2,3,6,12,13],world:3,wors:8,would:[3,9],wrap:[],writabl:3,written:[0,1,8,9],wrong:3,www:11,xml:8,yet:1,you:1,your:1,zeroth:1},titles:["Basic information","Dependencies","Ebuild file format","File system layout","Gentoo Policy Guide","Installed files","Keywording and stabilization","Language-specific policies","Package Maintainers","Motivation and history","Other policy documents","Other metadata variables","Preface","USE flags","Users and groups"],titleterms:{"case":1,"new":[6,8],"static":[3,5],Adding:8,FHS:10,USE:[1,11,13],absolut:3,account:14,appeal:0,author:12,basic:0,build:[],bump:1,chang:[0,1],check:0,code:2,complianc:0,contain:2,contribut:[],depend:1,deprec:7,develop:10,document:[9,10],drop:6,dynam:11,ebuild:2,eclass:[2,7],edit:[],enforc:0,extern:10,file:[2,3,5],flag:[1,11,13],format:2,game:3,gentoo:[4,10],get:[],glep:10,goal:0,gp0001:[],group:14,gui:13,guid:[4,9],histor:9,histori:9,homepag:[2,11],indic:4,inform:0,instal:[3,5],introduct:12,keyword:6,languag:7,layout:3,librari:[3,5],libtool:[3,5],licens:12,link:3,locat:3,maintain:8,make:0,manag:10,manual:10,meaning:11,metadata:11,motiv:9,multilib:3,multislot:11,must:[2,11],name:13,oper:1,option:1,other:[10,11],ownership:3,packag:[1,8,10],path:3,polici:[0,4,7,9,10,14],posix:10,prefac:12,proactiv:1,publish:[],purpos:9,python:7,refer:2,rekeyword:6,remov:[6,8],restrict:11,revis:1,runtim:1,send:[],separ:3,slot:[1,11],small:5,sourc:[],special:1,specif:[7,10],src_uri:2,stabil:6,stabl:6,standard:10,state:9,strict:3,style:2,sub:1,subslot:1,support:3,symbol:3,system:3,tabl:4,target:3,test:11,thi:[],todo:[3,6,13],underscor:13,updat:[],usag:7,use:1,user:14,usr:3,valu:11,variabl:[2,11],version:[6,13],within:2,without:[1,8]}})
\ No newline at end of file +Search.setIndex({docnames:["basics","dependencies","ebuild-format","filesystem","index","installed-files","keywords","languages","maintainer","motivation","other-docs","other-metadata","preface","use-flags","user-group"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.index":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":2,sphinx:56},filenames:["basics.rst","dependencies.rst","ebuild-format.rst","filesystem.rst","index.rst","installed-files.rst","keywords.rst","languages.rst","maintainer.rst","motivation.rst","other-docs.rst","other-metadata.rst","preface.rst","use-flags.rst","user-group.rst"],objects:{},objnames:{},objtypes:{},terms:{"08gentoo":3,"2fuse":11,"80librari":3,"80multilib":3,"83cc5bbd7bbe8bdf04dd3c3bc7f8a035":11,"9cae3a92412a007febe7ac0612d50f5f":1,"break":[2,7],"case":[0,3,4,6,11],"class":0,"default":[1,5],"final":[0,9,10],"function":[0,2,3,7],"g\u00f3rny":12,"import":[1,7,11,14],"long":[1,6,7,11],"micha\u0142":12,"new":[3,4,7,9,13,14],"public":1,"static":[4,11],"switch":13,"true":14,"try":[0,2,8],"var":3,"while":[0,1,2,5,11],Adding:4,FHS:4,For:[1,3,8],Its:[0,9],PMS:[1,9,10,11],Such:[5,11],The:[0,1,2,3,4,6,7,8,9,10,11,12,13,14],There:[1,5,8,9],USE:[4,5],Use:2,Using:1,With:3,abi:[1,3],abil:[2,9,11],abolish:0,about:11,absolut:4,accept:[1,3,11,14],access:3,accident:7,accord:1,account:[1,2,4],acct:14,achiev:0,across:[0,9],action:0,activ:10,actual:8,add:[2,8],added:[3,5,8],adding:[1,8,14],addit:[2,3,5,9,10],addition:0,address:9,adjust:13,adopt:14,advantag:[2,13],affect:[0,2,6,11],aforement:[3,9],after:[0,1,3],afterward:13,against:[0,2,9,11],agre:8,aid:14,aim:[0,1,4,8,12,13],align:2,all:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],alloc:14,allow:[2,11],along:[3,9],alreadi:[1,3,7,11],also:[0,7,9,13],alter:11,alwai:[2,3],amd64:3,amount:9,analyz:0,ani:[1,2,5,8,9,10,11,13],anoth:[1,3,11],anymor:[3,6],anywher:11,api:1,app:5,appeal:4,append:2,appli:[0,1,6,8,9,10],applic:[1,3,5,9,10,11],appropri:[3,11],approv:[1,10,14],arbitrari:14,arch:[2,6],architectur:[0,3,6],archiv:[1,5,11,13],area:0,argu:1,aris:[9,13,14],ask:[0,6],assign:[8,14],assum:[1,13],assumpt:11,attempt:[2,5,9,13],attribut:12,author:4,autom:0,autotool:5,avail:[1,9,11,13],avoid:[2,5],awar:8,backup:8,bad:[1,3,11],base:5,baselayout:14,bash:[2,5],basic:[4,10],becom:[1,4,8,12],been:[1,3,5,11,13,14],befor:[0,6,13,14],behavior:[0,1,5,11],being:[1,5,6,7,8,11],besid:10,better:[7,9],between:[3,7,11,13,14],bin:3,binari:11,bind:[4,9,12],bit:3,blurri:3,bodi:[0,4,9,12],boot:3,both:[0,2,4,5,7,12,13],boundari:3,bracket:2,breakag:[1,6],broken:3,brought:5,browser:3,bug:[2,6,8,11,14],build:[0,1,3,5,7,11,13],builtin:2,bump:[4,14],bundl:11,burden:8,cach:11,call:[1,7],can:[0,1,3,4,6,9,10,11,12,13,14],care:8,categori:5,caus:[1,5,6,7,11,13],cf3f5a59ac918335766632bd02438722:13,chanc:[7,8],chang:[2,4,7,10],check:[1,3,4],choic:[2,13],choos:[11,13],chosen:14,chost:3,circumst:[1,11],claim:1,clarifi:3,clean:1,clear:[4,9,12,13],close:6,code:[0,1,4,7,11],collect:9,collis:14,combin:[0,4,9,11,12],comment:8,commit:0,common:[1,2,11,12],compar:8,compat:[3,7],compil:0,complet:[5,9,11],compli:10,complianc:4,compon:0,concept:0,concis:9,condit:[2,11],config:5,conform:[9,10],confus:[2,6,13],consent:8,consequ:5,consid:[5,11,13],consist:[0,2,7,13],construct:2,contact:0,contain:[4,8,10,13],content:[2,4],context:5,contrari:11,contribut:0,control:[1,3,5,11,13],controlled_optional_rdepend:1,convert:[2,13],copi:2,correct:[1,3,11],correctli:[0,2,3],correspond:[1,3],cost:[5,7],could:[5,8,11],council:[0,1,3,4,9,10,12,13],cover:11,creat:[0,3,9,10,13,14],creativ:12,cross:14,ctarget:3,cumbersom:1,current:[0,3,4,8,12],dai:6,data:3,debat:1,decid:[1,11],decis:[0,9],declar:11,dedic:[8,11],defer:7,defici:9,defin:[1,4,7,10,13],definit:[4,12],delai:[7,14],depclean:11,depend:[2,4,5,6,7,11,13],dependent_slot:11,deprec:[4,14],deriv:11,design:[2,4,12],desir:14,detail:10,detect:[0,1],dev:[1,3,8,11,13],develop:[0,1,2,3,4,6,8,9,12,13,14],devmanu:[9,10],did:[5,9,11],die:5,differ:[0,1,2,11],difficult:3,direct:[0,11],directli:[0,7,9],directori:[2,3],disabl:[1,11],disagre:[0,10],disciplinari:0,discourag:[5,13],discov:13,discuss:[10,13],distinguish:[8,13],distribut:[3,10],distro:14,doc:3,document:[0,4,11,12],doe:[1,5,6,8,10,11],done:10,dosym:3,doubt:[0,14],down:[0,9],download:11,downward:14,drop:[4,8],dropping_stable_keyword:6,due:[1,3,5,6],duplic:6,dure:[1,3],dynam:[1,2,3,4,14],each:[0,1,9,11],eapi:10,earli:[3,7],easi:[0,11],easier:[0,13],easili:8,eblit:2,ebuild:[0,1,3,4,5,7,9,10,11],eclass:[1,4,11,14],edit:[2,9],editor:2,educ:0,effect:11,effort:[0,6],eight:9,either:[1,3,5,6,7,11,13],ekeyword:2,elog:1,emerg:11,enabl:[1,5,11,13],encourag:2,end:[0,7,8,13],enforc:[2,4,10,11],enough:11,ensur:[1,3,7,11],entri:[2,14],equal:1,equival:1,error:[1,2,11],especi:[1,3],establish:9,etc:[0,2,3],eutil:1,eval:2,even:[1,11,13],everi:9,exampl:[1,3,5,8,11],except:[1,3,6],execut:[0,3,11],exempt:6,exist:[1,7,11,13,14],expect:0,experi:0,experienc:[0,1],experiment:6,explan:9,explicit:[1,11],explicitli:[1,2,5,7,8,9,11,13,14],exponenti:7,express:[11,13],extend:13,extern:[2,4],fact:1,facto:9,fail:11,fallback:5,far:[0,9,11],fatal:[3,11],favor:14,featur:[1,11],few:[2,13],file:[0,4,6,8,9,11],filesystem:[3,10],find:[5,8,9,11],first:[5,6],fit:8,fix:[0,8,14],flag:[0,4,5],flat:[9,13],flip:1,focu:0,focus:[0,9],follow:[0,3,5,6,8,10,14],foo:[1,2],forbidden:[2,8,11],form:[2,9,13],formal:9,format:[4,10,11],former:[1,9],found:[3,9],free:14,frequent:[7,8],frobnic:3,from:[1,2,3,6,8,9,11,14],fulfil:3,full:[3,5],fulli:2,further:[0,14],furthermor:[1,2,3,8,9,11],futur:[1,6,8,10,13,14],game:4,gamestat:3,gap:14,gener:[2,3,5,10,11,13],gentoo:[0,1,2,3,6,7,8,9,11,12,13,14],get:1,gid:14,git:3,github:2,gitweb:3,give:7,glep:[0,1,4,14],global:[4,11,12,13],gnu:3,goal:[4,5],goe:2,going:[5,9],good:[1,3,11,14],govern:0,gpl:11,grab:8,gracefulli:[7,11],grant:3,graph:[1,6,7],grep:[2,8],group:[3,4,8],grow:7,gtk2:[1,13],gtk3:13,gtk:13,guarante:[7,11],gui:4,guid:[10,12],guidelin:[3,10],guix:3,hack:3,had:[1,6],hand:2,handl:[7,11],hard:[2,8,9,11,13],hardcod:[3,5],harder:2,harm:[5,11],has:[1,2,3,5,7,11,13,14],have:[1,2,5,6,7,11,14],help:[0,1,2,8],helper:7,here:[5,6,9],hierarch:13,hierarchi:3,high:3,highest:10,highlight:2,his:[0,7],histor:[1,2,3,4,5,11,13,14],histori:4,hold:3,homepag:4,host:3,hour:5,how:[1,9,10],howev:[5,6,9,10,11],http:[1,2,3,6,7,11,13,14],huge:5,hyphen:13,idea:1,identifi:11,imit:13,immedi:[1,6],immin:14,implement:[0,1,7,10,11],impli:3,implicitli:1,impos:10,imposs:5,improv:13,inappropri:8,incident:2,includ:[0,1,2,3,5,8,11],inconsist:3,increas:[1,8],indent:2,independ:6,index:[1,2,4,6,11,13],indic:[0,1,3,9,12],individu:2,infer:[1,11],inform:[1,4,8,9,11],init:11,initramf:3,instal:[0,1,4,7,11,13],install_mask:5,instead:[1,3,7],instruct:10,intend:9,interchang:1,interest:[6,8],intern:12,introduc:[5,7,13],introduct:[4,13],invalid:11,invari:11,investig:2,involv:0,ish:2,isol:3,issu:[0,5,7,13],its:[1,3,7,9,10],itself:10,ius:11,job:11,justifi:14,keep:5,kept:6,keyword:4,kind:0,knowledg:8,known:[0,6,11],lack:9,languag:4,larg:[2,8,9],larger:3,last:[6,8],later:7,latter:[1,3,9,11,13],layout:[4,10],lead:14,least:[1,2,6,11],leav:[2,14],lengthen:13,less:[0,2,9,11],level:[2,3,10],lib64:3,lib:[1,3,5],libbar:1,libexec:3,libfoo:1,libfrobn:1,libpython:7,librari:[1,4],libreoffic:5,libtool:4,licens:4,life:7,like:13,likeli:0,likewis:1,limit:[0,2],line:4,liner:5,link:[1,4,5,7,11],linker:[0,3],lint:[0,2],linux:10,list:[0,3,5,8,9,10,11,14],liter:2,littl:[2,11],load:2,loader:[3,5],local:[5,13],locat:[2,4,5,11],log:[1,3,9,13],logic:[1,9],longer:[1,3,8],lose:[1,7],lost:8,lot:9,low:13,lowest:14,made:[3,13],mai:[1,3,5,10,13],mail:[0,6,8,10],maintain:[0,3,4,6,7,9,10,12],mainten:[2,7,8],major:[0,7,10,11,14],make:[1,2,3,4,5,7,8,9,11,13],manag:[0,1,3,4,11],mani:[1,3,5,7,8,10,11],manual:[4,13],marker:11,match:[1,7,14],mean:[1,13],meaning:4,meant:[4,6,8,12],measur:0,meet:[1,3,9,13],member:[0,8],mention:9,mere:8,messag:[1,11,13],metadata:[3,4,8],method:2,mgorni:12,might:5,migrat:14,minim:7,minor:[0,6],mismatch:13,miss:[1,11],mistak:[0,1,11],modern:3,modifi:2,modul:7,moment:1,more:[2,5,9,10,11,13],most:2,motiv:4,mount:3,move:[2,3],mtab:3,much:[5,11],multi:2,multilib:4,multipl:[2,11,13],multislot:4,must:[1,3,4,5,6,7,8,13,14],name:[2,3,4,5],necessari:[1,5,8,13],need:[1,3,5,8,9,10,11,13,14],needless:1,neg:[5,6],neglect:6,neither:8,never:[3,5,9],nevertheless:10,newest:1,newli:13,next:14,nix:3,no_homepag:11,non:[0,1,2,3,6,9,11],nonfunct:1,nor:[1,8],normal:[3,11],noth:11,notic:[1,5],number:[2,7,8,14],obsolet:9,obtain:13,offer:13,often:[6,8],old:[1,3,6,7,8,11],oldid:[1,6,11,13],omit:11,onc:[1,2,6,8],one:[1,3,5,6,7,8,11],ones:14,onli:[1,2,3,5,6,9,10,11],open:[1,14],oper:[4,10],oppon:1,opportun:1,opt:3,optfeatur:1,option:[4,11,13],order:[0,1,3,5,7,9,11],org:[1,2,3,6,7,11,13,14],organ:9,origin:[8,9,11],other:[0,1,2,3,4,5,6,7,8,9,12,13],otherwis:[1,5],out:[1,7,8,9,13],over:[0,6],overlai:11,overlap:2,overrid:[0,10],overspecifi:11,own:3,ownership:4,packag:[0,2,3,4,5,6,7,11,13,14],page:[2,4,9,10],paludi:1,parallel:11,part:[1,2,3,9],partial:[2,9,10],particular:[5,9],partit:3,past:[2,9],path:[0,4,5],per:13,period:0,permit:[1,2,3,8,11],person:[0,6,13],phase:[0,2,7,13],php:[1,6,11,13],pkg:5,pkgcheck:[0,1,2,3,6,7,11,13,14],place:[1,5,6],plain:[1,2],pleas:[8,11],plugin:5,point:[1,3,5,9],pointless:14,polici:[1,5,6,8,11,12,13],port:7,portabl:[0,1,5],portag:[1,3],posix:[2,4],possibl:[0,1,2,7,8,9],potenti:[5,11],practic:[0,5],pre:11,precis:9,predict:1,prefac:4,prefer:[1,7,13],prepar:7,preprocess:2,prerequisit:11,present:11,prevent:[1,8,14],previou:[0,1,6],primari:[9,11],primit:14,principl:2,prioriti:13,privat:1,privileg:3,proactiv:4,problem:[0,1],proc:3,proceed:6,process:[2,4,6,10,12,14],profil:[3,8],program:[5,7,8],proj:3,project:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],prolifer:5,prone:2,propag:1,proper:13,propon:1,propos:1,protect:11,provid:[0,5,7,9,10,11,14],pull:1,purpos:[3,4,11],push:[0,14],pypi:2,python:[4,8],python_2_end:7,python_compat:7,python_gen_cond_dep:7,python_single_target:7,python_single_usedep:7,python_target:7,python_usedep:7,qt4:13,qt5:13,qualiti:0,quality_assur:[1,6,11,13],queri:[9,11],question:[0,1,3,6,8,11],rang:[1,14],rapid:14,rather:[2,9,10,13],rational:[1,2,3,4,5,6,7,8,9,11,12,13,14],reach:7,readabl:3,readi:7,readm:1,realli:[5,9],reason:[1,3,14],reassign:8,rebuild:[1,5],recommend:[2,5,10,13,14],reconsid:1,recoveri:[3,5],reduc:[0,2,7],refer:[1,3,4,6,7,9,11,13,14],refin:1,refus:[0,8],regard:0,regular:[13,14],reject:9,rekeyword:4,rel:3,relat:[0,9],relev:[0,6,11],reli:[1,3],reliabl:[0,7],remain:6,rememb:11,remov:[1,4,5,7,11,13,14],render:2,repair:3,repeat:[0,2],replac:[5,9,13],repo:3,repoman:[0,1,2,3,6,14],report:[0,1,2,3,5,6,7,8,11,13,14],repositori:[0,9,10,11],request:[0,1,6,14],requir:[1,3,5,7,9,10,11,14],resembl:13,reserv:[13,14],resign:8,resolv:[0,11],respond:6,respons:[1,11,13,14],restrict:[1,3,4,9,10],result:[1,14],retest:6,retir:7,reus:14,revers:[1,5,7],review:[10,14],revis:[3,4],risk:0,rite:6,role:0,root:3,rootf:3,rule:[2,6,10,11,13,14],run:[0,3],runtim:[4,7,11],same:[0,11,14],sbin:3,scale:9,scan:0,scatter:9,scope:11,score:3,script:[3,7,11],search:4,second:14,section:1,secur:5,select:14,self:3,send:8,separ:[4,11],serv:14,servic:[0,5],set:[1,2,4,9,12,13],setgid:3,setup:[0,3],share:[3,5],sharealik:12,shell:5,shorter:13,should:[0,1,3,5,6,7,9,10,11,13,14],side:1,silent:8,similar:11,simpl:[13,14],simplest:11,simpli:1,simplifi:14,simultan:11,sinc:[2,3,5,11,13],singl:[4,9,11],size:5,skip:11,slack:6,slot:[4,7],small:[3,4,8],smaller:5,softwar:[0,3,10],sole:8,solut:1,some:[3,6,9,11],soon:7,sooner:7,sourc:[1,2,3,4,5,6,7,8,9,11,12,13,14],space:[3,11],span:1,special:[3,4,11,13],specif:[0,1,4,5,9,11,12,13],specifi:[1,2,10,11],spend:5,spirit:9,split:8,src:3,src_uri:4,srv:3,stabil:4,stabl:[1,4],stale:9,standard:[2,4],start:[1,9,14],state:[3,4,11],still:[1,3,6,13],strict:4,strictli:[3,11],strip:5,strongli:5,style:[1,4],sub:4,subdirectori:3,subpag:11,subsequ:10,subset:6,subslot:4,subtli:3,success:14,suffer:8,suffici:9,suffix:3,suggest:10,summari:[1,3,13],supplement:[0,5],suppli:[4,12],support:[0,1,2,4,5,7,11,13],suppos:3,sure:[2,8],surpris:[0,2],symbol:4,symlink:3,sync:14,synchron:14,syntax:2,system:[0,4,5,10,11,14],systemd:[0,5],tab:2,take:[0,1,6,8],target:4,task:0,team:[0,2,3,4,6,8,9,12,13],technic:[3,5,8,9,10,11,13],temporarili:11,tent:1,term:7,termin:2,test:[0,2,4],text:12,than:[0,2,5,7,9,10,13],thei:[0,1,3,5,6,8,11,13],them:[0,3,5,8,9,10,13],themselv:5,therefor:[1,2,3,4,9,12],thi:[0,1,2,3,5,6,8,9,10,11,12,13,14],those:[0,2,3,7,8,11],three:[0,1],through:[7,10],tild:1,time:[0,1,6,7,9,11],timefram:1,tini:5,tip:9,titl:[1,6,11,13],todai:5,toggl:1,tool:[0,1,2,5],toolchain:[3,11],toolkit:13,top:3,tracker:11,tree:[0,3,4,9,10,12],trigger:[0,11],triplet:3,trivial:[0,11],turn:[9,11],two:[0,11],txt:[1,3,13,14],udev:3,uid:14,unclear:9,uncommon:[1,5],uncondition:[5,11],undefin:11,under:[1,11,12],underscor:4,understand:9,unfair:8,unit:[0,5],unless:[1,5,7,8,14],unmaintain:8,unnecessari:[2,5,6,7,13],unnecessarili:[1,13],unpredict:11,unprefix:13,unreli:1,unset:11,until:7,unus:2,unwilling:0,updat:[1,4,9,10,12,14],upgrad:[7,11],upon:10,upstream:[3,7,11],uri:2,usag:[1,4,9],use:[0,2,3,4,5,7,9,11,13,14],use_expand:13,used:[1,2,3,5,7,8,11,13,14],usefulness:2,user:[0,1,3,4,5,7,8,11,13],uses:[1,7,11,13],using:[0,1,2,3,5,7,11,14],usr:4,usual:[1,11],valid:13,valu:[1,2,3,4],variabl:[4,7],variant:3,variou:[0,8,9,13],verbatim:2,veri:[1,3,5,8,9,13,14],verifi:[1,11],version:[1,2,3,4,11,14],versioned_use_flag:13,via:[2,3,9,10,11,13,14],violat:[0,11],wai:[1,9,11,13],want:[6,13],warn:1,wast:3,web:[3,11],well:[2,4,6,9,10,11,12],were:[1,2,5,6,9,11,14],what:8,when:[0,1,2,3,5,8,10,11,13],whenev:[1,2,3,5,6,10,11,13],where:3,whether:[0,1,6],which:[1,2,4,6,9,11,12,13],who:[1,5,6,8,9,13],whole:7,why:8,wide:0,wider:9,widget:13,width:2,wiki:[1,6,7,9,10,11,13],wildcard:1,wish:[5,13],within:[1,3,4,6,8,13],without:[0,2,3,4],word:9,work:[0,2,3,6,11,12,13],world:3,wors:8,would:[3,9],wrap:2,writabl:3,written:[0,1,8,9],wrong:[3,11],www:11,xml:8,yet:1,you:1,your:1,zeroth:1},titles:["Basic information","Dependencies","Ebuild file format","File system layout","Gentoo Policy Guide","Installed files","Keywording and stabilization","Language-specific policies","Package Maintainers","Motivation and history","Other policy documents","Other metadata variables","Preface","USE flags","Users and groups"],titleterms:{"case":1,"new":[6,8],"static":[3,5],Adding:8,FHS:10,USE:[1,11,13],absolut:3,account:14,appeal:0,author:12,basic:0,bump:1,chang:[0,1],check:0,code:2,complianc:0,contain:2,defin:2,depend:1,deprec:7,develop:10,document:[9,10],drop:6,dynam:11,ebuild:2,eclass:[2,7],enforc:0,extern:10,file:[2,3,5],flag:[1,11,13],format:2,game:3,gentoo:[4,10],glep:10,goal:0,group:14,gui:13,guid:[4,9],histor:9,histori:9,homepag:[2,11],indic:4,inform:0,instal:[3,5],introduct:12,keyword:[2,6],languag:7,layout:3,librari:[3,5],libtool:[3,5],licens:[11,12],line:2,link:3,locat:3,maintain:8,make:0,manag:10,manual:10,meaning:11,metadata:11,motiv:9,multilib:3,multislot:11,must:[2,11],name:13,oper:1,option:1,other:[10,11],ownership:3,packag:[1,8,10],path:3,polici:[0,4,7,9,10,14],posix:10,prefac:12,proactiv:1,purpos:9,python:7,refer:2,rekeyword:6,remov:[6,8],restrict:11,revis:1,runtim:1,separ:3,singl:2,slot:[1,11],small:5,special:1,specif:[7,10],src_uri:2,stabil:6,stabl:6,standard:10,state:9,strict:3,style:2,sub:1,subslot:1,support:3,symbol:3,system:3,tabl:4,target:3,test:11,todo:[3,6,13],underscor:13,usag:7,use:1,user:14,usr:3,valu:11,variabl:[2,11],version:[6,13],within:2,without:[1,8]}})
\ No newline at end of file diff --git a/use-flags.html b/use-flags.html index c43dde1..8c5bb60 100644 --- a/use-flags.html +++ b/use-flags.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="Users and groups" href="user-group.html" /> @@ -76,8 +76,25 @@ <li class=""><a href="_sources/use-flags.rst.txt">Source</a></li> <li> <a href="search.html">Search</a></li> + + <li> - <a href="genindex.html">Index</a></li> + + <a href="genindex.html">General Index</a> + + </li> + + <li> + + <a href="std-policy-index.html">Policy Index</a> + + </li> + + + + + + @@ -115,17 +132,20 @@ <div class="section" id="use-flags"> <h1>USE flags<a class="headerlink" href="#use-flags" title="Permalink to this headline">¶</a></h1> -<div class="section" id="versioned-use-flags"> -<span id="index-0"></span><h2>Versioned USE flags<a class="headerlink" href="#versioned-use-flags" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0801"> +<span id="versioned-use-flags"></span><span id="index-0"></span><h2>Versioned USE flags<a class="headerlink" href="#pg0801" 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>0801</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#Versioned_USE_flags">https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=109991#Versioned_USE_flags</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>no</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#Versioned_USE_flags">https://wiki.gentoo.org/index.php?title=Project:Quality_Assurance/Policies&oldid=109991#Versioned_USE_flags</a></p> +</dd> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>no</p> </dd> </dl> <p>If a need arises to create new USE flags responsible for switching @@ -143,17 +163,20 @@ of the QA policy on gtk/gtk2/gtk3 flags. The latter policy has been removed since.</p> </div> </div> -<div class="section" id="use-gui-flag"> -<span id="index-1"></span><h2>USE=gui flag<a class="headerlink" href="#use-gui-flag" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0802"> +<span id="use-gui-flag"></span><span id="index-1"></span><h2>USE=gui flag<a class="headerlink" href="#pg0802" 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>0802</p> +</dd> +<dt class="field-even">Source</dt> +<dd class="field-even"><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/cf3f5a59ac918335766632bd02438722">https://archives.gentoo.org/gentoo-dev/message/cf3f5a59ac918335766632bd02438722</a></p> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://archives.gentoo.org/gentoo-dev/message/cf3f5a59ac918335766632bd02438722">https://archives.gentoo.org/gentoo-dev/message/cf3f5a59ac918335766632bd02438722</a></p> </dd> -<dt class="field-odd">Reported</dt> -<dd class="field-odd"><p>no</p> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>no</p> </dd> </dl> <p>Whenever a package offers an optional GUI support, the <code class="docutils literal notranslate"><span class="pre">gui</span></code> flag must @@ -169,17 +192,20 @@ to obtain the GUI) or enabling multiple toolkits globally which afterwards caused issues with packages supporting a choice between multiple GUIs.</p> </div> -<div class="section" id="underscores-in-use-flag-names"> -<span id="index-2"></span><h2>Underscores in USE flag names<a class="headerlink" href="#underscores-in-use-flag-names" title="Permalink to this headline">¶</a></h2> +<div class="section" id="pg0803"> +<span id="underscores-in-use-flag-names"></span><span id="index-2"></span><h2>Underscores in USE flag names<a class="headerlink" href="#pg0803" title="Permalink to this headline">¶</a></h2> <dl class="field-list simple"> -<dt class="field-odd">Source</dt> -<dd class="field-odd"><p>Council</p> +<dt class="field-odd">PG</dt> +<dd class="field-odd"><p>0803</p> +</dd> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>Council</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://projects.gentoo.org/council/meeting-logs/20191013-summary.txt">https://projects.gentoo.org/council/meeting-logs/20191013-summary.txt</a></p> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://projects.gentoo.org/council/meeting-logs/20191013-summary.txt">https://projects.gentoo.org/council/meeting-logs/20191013-summary.txt</a></p> </dd> -<dt class="field-odd">Reported</dt> -<dd class="field-odd"><p>by pkgcheck</p> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>by pkgcheck</p> </dd> </dl> <p>Underscores are reserved for USE_EXPAND flags, and must not be used @@ -256,9 +282,9 @@ or underscores depending on developer’s personal preference.</p> <li class="toctree-l1"><a class="reference internal" href="maintainer.html">Package Maintainers</a></li> <li class="toctree-l1"><a class="reference internal" href="other-metadata.html">Other metadata variables</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">USE flags</a><ul class='nav'> -<li class="toctree-l2"><a class="reference internal" href="#versioned-use-flags">Versioned USE flags</a></li> -<li class="toctree-l2"><a class="reference internal" href="#use-gui-flag">USE=gui flag</a></li> -<li class="toctree-l2"><a class="reference internal" href="#underscores-in-use-flag-names">Underscores in USE flag names</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0801">Versioned USE flags</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0802">USE=gui flag</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0803">Underscores in USE flag names</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="user-group.html">Users and groups</a></li> @@ -280,7 +306,7 @@ or underscores depending on developer’s personal preference.</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> diff --git a/user-group.html b/user-group.html index fd8219a..ac807fe 100644 --- a/user-group.html +++ b/user-group.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="prev" title="USE flags" href="use-flags.html" /> @@ -75,8 +75,23 @@ <li class=""><a href="_sources/user-group.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> + + + + @@ -114,17 +129,20 @@ <div class="section" id="users-and-groups"> <h1>Users and groups<a class="headerlink" href="#users-and-groups" title="Permalink to this headline">¶</a></h1> -<span class="target" id="index-0"></span><div class="section" id="user-and-group-account-policy"> -<span id="index-1"></span><h2>User and group account policy<a class="headerlink" href="#user-and-group-account-policy" title="Permalink to this headline">¶</a></h2> +<span class="target" id="index-0"></span><div class="section" id="pg0901"> +<span id="user-and-group-account-policy"></span><span id="index-1"></span><h2>User and group account policy<a class="headerlink" href="#pg0901" 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>0901</p> +</dd> +<dt class="field-even">Source</dt> +<dd class="field-even"><p>QA</p> </dd> -<dt class="field-even">Reference</dt> -<dd class="field-even"><p><a class="reference external" href="https://bugs.gentoo.org/702460">https://bugs.gentoo.org/702460</a></p> +<dt class="field-odd">Reference</dt> +<dd class="field-odd"><p><a class="reference external" href="https://bugs.gentoo.org/702460">https://bugs.gentoo.org/702460</a></p> </dd> -<dt class="field-odd">Reported</dt> -<dd class="field-odd"><p>by repoman and pkgcheck (as deprecated eclass)</p> +<dt class="field-even">Reported</dt> +<dd class="field-even"><p>by repoman and pkgcheck (as deprecated eclass)</p> </dd> </dl> <p>All new user/group accounts must be created via <a class="reference external" href="https://www.gentoo.org/glep/glep-0081.html">GLEP 81</a> packages. @@ -212,7 +230,7 @@ been reserved for true system users and groups.</p> <li class="toctree-l1"><a class="reference internal" href="other-metadata.html">Other metadata variables</a></li> <li class="toctree-l1"><a class="reference internal" href="use-flags.html">USE flags</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Users and groups</a><ul class='nav'> -<li class="toctree-l2"><a class="reference internal" href="#user-and-group-account-policy">User and group account policy</a></li> +<li class="toctree-l2"><a class="reference internal" href="#pg0901">User and group account policy</a></li> </ul> </li> </ul> @@ -233,7 +251,7 @@ been reserved for true system users and groups.</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> |