From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.61]) by mx.groups.io with SMTP id smtpd.web09.2477.1573123185776686199 for ; Thu, 07 Nov 2019 02:39:46 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=NgqpVOlw; spf=pass (domain: redhat.com, ip: 205.139.110.61, mailfrom: lersek@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1573123184; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=sDGN7+lKR2Wx9pTDrfGHKuQJB4qTKQnMiySiBppNuYo=; b=NgqpVOlwFxChhhu6uKflRer8Dt0Xbkux+me1fSQGXVBAW6d3qIO5aqlWgmbCBxgFMgSyFY 7QY1CI4O6CbB1su/zNm3doy8vVOTbnpibkcxN+zWWRoYuTkyTPsa1mkN/InxHLFk1jHOJ8 glUhMlk52GSsdgsaIdfZ36BkI3LQExg= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-374-qH0nmm-vOASuKcgK9EVgeQ-1; Thu, 07 Nov 2019 05:39:41 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 422041005500; Thu, 7 Nov 2019 10:39:40 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (unknown [10.36.118.71]) by smtp.corp.redhat.com (Postfix) with ESMTP id 163E35DA2C; Thu, 7 Nov 2019 10:39:38 +0000 (UTC) Subject: Re: [Patch v4 03/22] requirements.txt: Add python pip requirements file To: Michael D Kinney , devel@edk2.groups.io Cc: Sean Brogan , Andrew Fish , Leif Lindholm References: <20191107011349.16524-1-michael.d.kinney@intel.com> <20191107011349.16524-4-michael.d.kinney@intel.com> From: "Laszlo Ersek" Message-ID: <019f8e7f-388e-839b-d723-3d78027752fb@redhat.com> Date: Thu, 7 Nov 2019 11:39:37 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1 MIME-Version: 1.0 In-Reply-To: <20191107011349.16524-4-michael.d.kinney@intel.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-MC-Unique: qH0nmm-vOASuKcgK9EVgeQ-1 X-Mimecast-Spam-Score: 0 Content-Language: en-US Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable On 11/07/19 02:13, Michael D Kinney wrote: > From: Sean Brogan >=20 > Add pip requirements file that is used to install the > python pip modules build from the edk2-pytool-library and > edk2-pytool-extensions repositories. >=20 > These python modules provide the extensions required to > perform EDK II Continuous Integration(CI) builds. >=20 > Cc: Andrew Fish > Cc: Laszlo Ersek > Cc: Leif Lindholm > Signed-off-by: Michael D Kinney > --- > requirements.txt | 17 +++++++++++++++++ > 1 file changed, 17 insertions(+) > create mode 100644 requirements.txt >=20 > diff --git a/requirements.txt b/requirements.txt > new file mode 100644 > index 0000000000..4ad72cfc98 > --- /dev/null > +++ b/requirements.txt > @@ -0,0 +1,17 @@ > +## @file > +# EDK II Python PIP requirements file > +# > +# This file provides the list of python components to install using PIP. > +# > +# Copyright (c) Microsoft Corporation. All rights reserved.
> +# > +# SPDX-License-Identifier: BSD-2-Clause-Patent > +# > +# https://pypi.org/project/pip/ > +# https://pip.pypa.io/en/stable/user_guide/#requirements-files > +# https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file= -format > +# > +## > + > +edk2-pytool-library=3D=3D0.10.* > +edk2-pytool-extensions=3D=3D0.12.* >=20 This is better, but I still find the plain "requirements.txt" filename in the root directory of the project very confusing. What component *exactly* insists on this file path and file name? I've checked https://pip.pypa.io/en/stable/user_guide/#requirements-files and it seems like "pip" can take any pathname as an argument to option "-r"= . There must be a component in the CI environment that invokes "pip". Can we file a feature request for that component, that it try "pip-requirements.txt" first? Hmmm... I just googled "github pip requirements.txt", assuming that "github" was the component calling "pip". In the result list, I've found: https://github.com/ClearingHouse/clearinghoused/blob/master/pip-requirement= s.txt Is it possible that github already knows to look for "pip-requirements.txt"? (Honestly I only suggested "pip-requirements.txt" above because it seemed sensible.) If that's the case, we should use it. Furthermore, my understanding is that "the list of python components to install using PIP" is only there for CI purposes. Can we please state that explicitly in the comment block? (The commit message already does that, and that's great.) Basically when someone clones edk2 and runs "ls -l" for the first time, there's a good chance "requirements.txt" will be among the few files they open right after. Thanks! Laszlo