From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 2016C138350 for ; Fri, 21 Feb 2020 11:07:57 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 32E1CE082D; Fri, 21 Feb 2020 11:07:56 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [IPv6:2001:470:ea4a:1:5054:ff:fec7:86e4]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 0C327E082D for ; Fri, 21 Feb 2020 11:07:56 +0000 (UTC) Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id B1F6D34EEE3 for ; Fri, 21 Feb 2020 11:07:54 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 1B27F145 for ; Fri, 21 Feb 2020 11:07:52 +0000 (UTC) From: "Michał Górny" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Michał Górny" Message-ID: <1582283260.0834171b83aead95ae39e51272a9f89bb785e28b.mgorny@gentoo> Subject: [gentoo-commits] proj/policy-guide:master commit in: / X-VCS-Repository: proj/policy-guide X-VCS-Files: ebuild-format.rst X-VCS-Directories: / X-VCS-Committer: mgorny X-VCS-Committer-Name: Michał Górny X-VCS-Revision: 0834171b83aead95ae39e51272a9f89bb785e28b X-VCS-Branch: master Date: Fri, 21 Feb 2020 11:07:52 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: a3ef8037-a1ba-493d-b1d6-c968f56d30d8 X-Archives-Hash: 13910967b1a4b14554ab07ff4e392242 commit: 0834171b83aead95ae39e51272a9f89bb785e28b Author: Michał Górny gentoo org> AuthorDate: Tue Feb 18 17:05:52 2020 +0000 Commit: Michał Górny gentoo org> CommitDate: Fri Feb 21 11:07:40 2020 +0000 URL: https://gitweb.gentoo.org/proj/policy-guide.git/commit/?id=0834171b 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 gentoo.org> ebuild-format.rst | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) 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.