diff options
| author |   Michał Górny <mgorny@gentoo.org> | 2020-02-18 18:05:52 +0100 |
|---|---|---|
| committer | Michał Górny <mgorny@gentoo.org> | 2020-02-21 12:07:40 +0100 |
| commit | 0834171b83aead95ae39e51272a9f89bb785e28b (patch) | |
| tree | c119ce0bb8d014d504cc4252250e3a56a90aa346 | |
| parent | other-metadata: LICENSE (diff) | |
| download | policy-guide-0834171b83aead95ae39e51272a9f89bb785e28b.tar.gz policy-guide-0834171b83aead95ae39e51272a9f89bb785e28b.tar.bz2 policy-guide-0834171b83aead95ae39e51272a9f89bb785e28b.zip | |
ebuild-format: Require KEYWORDS to be on one line
Bug: https://bugs.gentoo.org/639724
Closes: https://github.com/gentoo/policy-guide/pull/13
Signed-off-by: Michał Górny <mgorny@gentoo.org>
| -rw-r--r-- | ebuild-format.rst | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/ebuild-format.rst b/ebuild-format.rst index d2c8dc5..ed9bde0 100644 --- a/ebuild-format.rst +++ b/ebuild-format.rst @@ -68,7 +68,6 @@ 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 @@ -87,3 +86,20 @@ 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 +----------------------------------------- +: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. |