diff options
Diffstat (limited to '_sources')
| -rw-r--r-- | _sources/ebuild-format.rst.txt | 18 | ||||
| -rw-r--r-- | _sources/installed-files.rst.txt | 2 | ||||
| -rw-r--r-- | _sources/other-metadata.rst.txt | 19 | ||||
| -rw-r--r-- | _sources/preface.rst.txt | 1 |
4 files changed, 28 insertions, 12 deletions
diff --git a/_sources/ebuild-format.rst.txt b/_sources/ebuild-format.rst.txt index 041c088..a381e07 100644 --- a/_sources/ebuild-format.rst.txt +++ b/_sources/ebuild-format.rst.txt @@ -126,3 +126,21 @@ allowed. *Rationale*: since license names do not contain dynamic parts (such as package versions), using variables there has little advantage. On the other hand, variables reduce the usefulness of plain tools such as grep. + + +.. index:: d; variable + +D must be used only in src_install and pkg_preinst +-------------------------------------------------- +:PG: 0107 +:Source: QA +:Reported: no + +The ``D`` and ``ED`` variables must be used only in the ``src_install`` +and ``pkg_preinst`` phase functions. Exceptions to this policy can be +granted by the QA team. + +*Rationale*: using ``D`` in other phases (e.g. ``src_configure``) is +error-prone and may lead to the path being embedded in files of the +installed image. In addition, the directory pointed to by ``${D}`` +does not exist in other phases. diff --git a/_sources/installed-files.rst.txt b/_sources/installed-files.rst.txt index da6263e..1468288 100644 --- a/_sources/installed-files.rst.txt +++ b/_sources/installed-files.rst.txt @@ -79,7 +79,7 @@ b. the package is installing static libraries that have additional It is recommended to use the following one-liner to remove .la files:: - find "${ED}" -name '*.la' -delete || die + find "${ED}" -type f -name '*.la' -delete || die *Rationale*: libtool files were historically introduced as an attempt to supplement static library archives with dependent library list. diff --git a/_sources/other-metadata.rst.txt b/_sources/other-metadata.rst.txt index d79ef6f..d3c98fd 100644 --- a/_sources/other-metadata.rst.txt +++ b/_sources/other-metadata.rst.txt @@ -105,10 +105,12 @@ LICENSE :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. +The ``LICENSE`` variable must explicitly list all licenses pertaining +to the "corresponding source" of the files installed by the package. +This includes all their source code, but also all scripts used to +control compilation and installation. 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, @@ -116,8 +118,8 @@ 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. +The licenses for files that are neither installed nor used at build +time shall not be listed. *Rationale*: the primary purpose of the license support in the package manager is to provide the users with ability to decide on acceptable @@ -137,11 +139,6 @@ 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). diff --git a/_sources/preface.rst.txt b/_sources/preface.rst.txt index 85344d4..e0af2d9 100644 --- a/_sources/preface.rst.txt +++ b/_sources/preface.rst.txt @@ -19,6 +19,7 @@ This document is maintained by the Gentoo `QA project`_. The current text authors are: - Michał Górny (mgorny) +- Ulrich Müller (ulm) License |