From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) by finch.gentoo.org (Postfix) with ESMTP id 2ACCF138252 for ; Wed, 11 May 2016 16:08:38 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 9AD9CE07EE; Wed, 11 May 2016 16:08:35 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id AEAECE07EE for ; Wed, 11 May 2016 16:08:34 +0000 (UTC) Received: from localhost.localdomain (c-98-218-46-55.hsd1.md.comcast.net [98.218.46.55]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: mjo@gentoo.org) by smtp.gentoo.org (Postfix) with ESMTPSA id 621DE340564 for ; Wed, 11 May 2016 16:08:33 +0000 (UTC) From: Michael Orlitzky To: gentoo-portage-dev@lists.gentoo.org Subject: [gentoo-portage-dev] [PATCH 1/1] Add a test case for PMS-compliant usage of the ROOT variable. Date: Wed, 11 May 2016 12:08:25 -0400 Message-Id: <1462982905-17867-2-git-send-email-mjo@gentoo.org> X-Mailer: git-send-email 2.7.3 In-Reply-To: <1462982905-17867-1-git-send-email-mjo@gentoo.org> References: <1462982905-17867-1-git-send-email-mjo@gentoo.org> Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-portage-dev@lists.gentoo.org Reply-to: gentoo-portage-dev@lists.gentoo.org X-Archives-Salt: 07200821-cac5-4b76-8f9e-d6fa24c9f353 X-Archives-Hash: 76194c63ac469e6a6210f04adeae96ac A recent thread on gentoo-dev proposed a change to the devmanual's description of the ROOT variable: https://archives.gentoo.org/gentoo-dev/message/8901669dd375ca0fdb610efef0ddfe6f The proposed change would bring the devmanual's language in line with the PMS. That discussion reveals that the use of ROOT outside of pkg_* is illegal, yet current versions of repoman/portage allow it. This commit adds a test ebuild that violates the PMS (with respect to ROOT) in several ways. --- ebuild-test/root-var-usage/metadata.xml | 24 ++++++ ebuild-test/root-var-usage/root-var-usage-0.ebuild | 90 ++++++++++++++++++++++ 2 files changed, 114 insertions(+) create mode 100644 ebuild-test/root-var-usage/metadata.xml create mode 100644 ebuild-test/root-var-usage/root-var-usage-0.ebuild diff --git a/ebuild-test/root-var-usage/metadata.xml b/ebuild-test/root-var-usage/metadata.xml new file mode 100644 index 0000000..f8ba4d0 --- /dev/null +++ b/ebuild-test/root-var-usage/metadata.xml @@ -0,0 +1,24 @@ + + + + + Test that the $ROOT variable is used according to the Package + Manager Specification (PMS). + + All currently-approved versions of the PMS state that the $ROOT + variable is legal only in the pkg_* phases. One common misuse is + to use $ROOT instead of $EPREFIX as "something more general than a + front-slash" in the src_* functions. We want to detect these + mistakes, and eventually eliminate all uses of $ROOT outside of + the PMS-defined pkg_* phases. + + + + exampledev@gentoo.org + Primary maintainer + + + exampleproject@gentoo.org + Gentoo Example Project + + diff --git a/ebuild-test/root-var-usage/root-var-usage-0.ebuild b/ebuild-test/root-var-usage/root-var-usage-0.ebuild new file mode 100644 index 0000000..a46339e --- /dev/null +++ b/ebuild-test/root-var-usage/root-var-usage-0.ebuild @@ -0,0 +1,90 @@ +# Copyright 1999-2016 Gentoo Foundation +# Distributed under the terms of the GNU General Public License v2 +# $Id$ + +EAPI=6 + +DESCRIPTION="Ensure ROOT variable usage complies with the PMS" +HOMEPAGE="https://dev.gentoo.org/~ulm/pms/head/pms.html#x1-11800011" +LICENSE="BSD" +SLOT="0" +KEYWORDS="~amd64" +IUSE="" + +# All uses of $ROOT within the pkg_* "Ebuild-defined functions" should +# be allowed. The list comes from the so-named chapter of the PMS. + +pkg_pretend() { + local foo=$ROOT +} + +pkg_setup() { + local foo="${ROOT}/foo" +} + +pkg_preinst() { + local foo="$ROOT" +} + +pkg_postinst() { + local foo="bar/${ROOT}" +} + +pkg_prerm() { + local foo="bar/${ROOT}/baz" +} + +pkg_postrm() { + local foo=bar/$ROOT +} + +pkg_config() { + local foo="$ROOT" +} + +pkg_info() { +local foo=$ROOT +} + +pkg_nofetch() { + local foo=`echo $ROOT` +} + +# All uses below here are errors. The following src_* functions are +# defined in the PMS. +src_unpack() { + local foo=$ROOT +} + +src_prepare() { + local foo="${ROOT}/foo" +} + +src_configure() { + local foo=`echo $ROOT` +} + +src_compile() { +local foo=$ROOT +} + +src_test() { + local foo=$(echo $ROOT) +} + +src_install() { + local foo="bar/${ROOT}/baz" +} + +pkg_apocrypha(){ + # This function begins with "pkg_", but isn't defined in the PMS. + local foo=bar/$ROOT +} + +washington_irving(){ + # This function is arbitrarily-named and not defined in the PMS. + local foo="${ROOT}/foo" +} + +# And I suppose we should check that it's not used in global scope, too. +DEPEND="sys-libs${ROOT}glibc" -- 2.7.3