From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 134.134.136.126, mailfrom: michael.d.kinney@intel.com) Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) by groups.io with SMTP; Wed, 10 Jul 2019 10:28:30 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 10 Jul 2019 10:28:29 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.63,475,1557212400"; d="scan'208";a="186187904" Received: from orsmsx103.amr.corp.intel.com ([10.22.225.130]) by fmsmga001.fm.intel.com with ESMTP; 10 Jul 2019 10:28:28 -0700 Received: from orsmsx122.amr.corp.intel.com (10.22.225.227) by ORSMSX103.amr.corp.intel.com (10.22.225.130) with Microsoft SMTP Server (TLS) id 14.3.439.0; Wed, 10 Jul 2019 10:28:28 -0700 Received: from orsmsx113.amr.corp.intel.com ([169.254.9.128]) by ORSMSX122.amr.corp.intel.com ([169.254.11.139]) with mapi id 14.03.0439.000; Wed, 10 Jul 2019 10:28:28 -0700 From: "Michael D Kinney" To: Leif Lindholm , "Kinney, Michael D" CC: "Wang, Jian J" , "devel@edk2.groups.io" , "Gao, Liming" Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands Thread-Topic: [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands Thread-Index: AQHVNyt7QbIMXqjtfUygGv1SZoonz6bEFVeggAB4ZAD//409gA== Date: Wed, 10 Jul 2019 17:28:27 +0000 Message-ID: References: <20190710060955.7672-1-jian.j.wang@intel.com> <20190710060955.7672-2-jian.j.wang@intel.com> <20190710142629.aomcdzwvapo34k6c@bivouac.eciton.net> <20190710171734.m36astajy7v55xur@bivouac.eciton.net> In-Reply-To: <20190710171734.m36astajy7v55xur@bivouac.eciton.net> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows dlp-version: 11.0.600.7 dlp-reaction: no-action x-originating-ip: [10.22.254.140] MIME-Version: 1.0 Return-Path: michael.d.kinney@intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable > -----Original Message----- > From: Leif Lindholm [mailto:leif.lindholm@linaro.org] > Sent: Wednesday, July 10, 2019 10:18 AM > To: Kinney, Michael D > Cc: Wang, Jian J ; > devel@edk2.groups.io; Gao, Liming > Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule > policy and clone commands >=20 > On Wed, Jul 10, 2019 at 05:08:32PM +0000, Kinney, Michael > D wrote: > > Leif, > > > > I think the following command has to be run from the > git dir that the > > edk2 repo was cloned into. > > > > $ git submodule update --init > > > > So I think the correct instructions would be: > > > > $ git clone https://github.com/tianocore/edk2.git > > $ cd edk2 > > $ git submodule update --init >=20 > I only said I reviewed it, not that the review was > correct ;) >=20 > Yeah, good catch. I just mentally filtered out the clone > bit. >=20 > > $ cd .. >=20 > Why would you want to leave? Because the commands the follow are more clone commands for edk2-platforms and edk2-non-osi. Could move the submodule init action for the edk2 repo after all the clone operations. >=20 > / > Leif >=20 > > Mike > > > > > -----Original Message----- > > > From: Leif Lindholm [mailto:leif.lindholm@linaro.org] > > > Sent: Wednesday, July 10, 2019 7:27 AM > > > To: Wang, Jian J > > > Cc: devel@edk2.groups.io; Kinney, Michael D > > > ; Gao, Liming > > > > Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule > policy and > > > clone commands > > > > > > On Wed, Jul 10, 2019 at 02:09:54PM +0800, Jian J Wang > > > wrote: > > > > > v2: update wording per Leif's and others' > comments > > > > > > Please drop the above line - version comments can go > below the --- > > > line, so they don't get included in the commit > message. > > > > > > With that: > > > Reviewed-by: Leif Lindholm > > > > > > (although Liming had some further feedback) > > > > > > > REF: > > > https://bugzilla.tianocore.org/show_bug.cgi?id=3D1910 > > > > > > > > A section 'Submodules' is added to clarify the > > > submodule policy in > > > > edk2 repo. Git commands are also added to show the > > > correct way to > > > > clone submodule repos, in which '--recursive' is > > > removed because it's > > > > not needed but recommended in other document. > > > > > > > > Related commits: > > > > Openssl-1.1.1b upgrade: > > > acfb90911840c38a0beb9bcfe0065668244d2b4d > > > > berkeley-softfloat-3: > > > 3cc57695df5a6e8c65fb46b993836c315cabf49d > > > > > > > > Cc: Leif Lindholm > > > > Cc: Michael D Kinney > > > > Cc: Liming Gao > > > > Signed-off-by: Jian J Wang > > > > --- > > > > Readme.md | 28 ++++++++++++++++++++++++++++ > > > > 1 file changed, 28 insertions(+) > > > > > > > > diff --git a/Readme.md b/Readme.md index > e564c6c09b..c475468655 > > > > 100644 > > > > --- a/Readme.md > > > > +++ b/Readme.md > > > > @@ -143,3 +143,31 @@ Signed-off-by: Contributor > Name > > > > > > > the change. Each line should be less than ~70 > > > characters. > > > > * `Signed-off-by` is the contributor's signature > > > identifying them > > > > by their real/legal name and their email > address. > > > > + > > > > +# Submodules > > > > + > > > > +As a general policy, submodule chain should be > avoided > > > in EDK II repo > > > > +as possible as we can. Currently EDK II contains > two > > > submodules > > > > + > > > > +- CryptoPkg/Library/OpensslLib/openssl > > > > +- ArmPkg/Library/ArmSoftFloatLib/berkeley- > softfloat-3 > > > > + > > > > +The latter one is actually required by previous > one. > > > It's inevitable > > > > +in openssl-1.1.1 (since stable201905) for floating > > > point parameter > > > > +conversion, but should be dropped once there's no > such > > > need in future > > > > +release of openssl. > > > > + > > > > +To get a full, buildable EDK II repository, use > > > following two steps > > > > +of git command > > > > + > > > > +``` > > > > +$ git clone https://github.com/tianocore/edk2.git > > > > +$ git submodule update --init> > +``` > > > > + > > > > +Note: When cloning submodule repos, '--recursive' > > > option is not > > > > +recommended. EDK II itself will not use any > > > code/feature from > > > > +submodules in above submodules. So using '-- > recursive' > > > adds a > > > > +dependency on being able to reach servers we do > not > > > actually want any > > > > +code from, as well as needlessly downloading code > we > > > will not use. > > > > -- > > > > 2.17.1.windows.2 > > > >