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: jian.j.wang@intel.com) Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) by groups.io with SMTP; Wed, 10 Jul 2019 23:49:57 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 10 Jul 2019 23:49:56 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.63,476,1557212400"; d="scan'208";a="177076375" Received: from fmsmsx108.amr.corp.intel.com ([10.18.124.206]) by orsmga002.jf.intel.com with ESMTP; 10 Jul 2019 23:49:56 -0700 Received: from fmsmsx113.amr.corp.intel.com (10.18.116.7) by FMSMSX108.amr.corp.intel.com (10.18.124.206) with Microsoft SMTP Server (TLS) id 14.3.439.0; Wed, 10 Jul 2019 23:49:56 -0700 Received: from shsmsx153.ccr.corp.intel.com (10.239.6.53) by FMSMSX113.amr.corp.intel.com (10.18.116.7) with Microsoft SMTP Server (TLS) id 14.3.439.0; Wed, 10 Jul 2019 23:49:56 -0700 Received: from shsmsx107.ccr.corp.intel.com ([169.254.9.162]) by SHSMSX153.ccr.corp.intel.com ([169.254.12.60]) with mapi id 14.03.0439.000; Thu, 11 Jul 2019 14:32:53 +0800 From: "Wang, Jian J" To: "Gao, Liming" , "devel@edk2.groups.io" CC: Leif Lindholm , "Kinney, Michael D" Subject: Re: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands Thread-Topic: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands Thread-Index: AQHVNuYbgOx/8EODvUSFlotmKE2H2KbDd/KQgAFM64A= Date: Thu, 11 Jul 2019 06:32:52 +0000 Message-ID: References: <20190710060955.7672-1-jian.j.wang@intel.com> <20190710060955.7672-2-jian.j.wang@intel.com> <4A89E2EF3DFEDB4C8BFDE51014F606A14E4A5056@SHSMSX104.ccr.corp.intel.com> In-Reply-To: <4A89E2EF3DFEDB4C8BFDE51014F606A14E4A5056@SHSMSX104.ccr.corp.intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiYjNhNmEwZTgtYTc4My00YWIyLWEwN2UtMWIxNDQ2YTYwYmJiIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiM3Nqd2pyeTJmSzVpNkJEQ3BRSzFhQlZJR3FpM3NtK295NVNrd3IzRVY4UlJtZVNrbFI3NzBqc1VhTW0rUXFTRCJ9 x-ctpclassification: CTP_NT dlp-product: dlpe-windows dlp-version: 11.0.600.7 dlp-reaction: no-action x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Return-Path: jian.j.wang@intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Liming, > -----Original Message----- > From: Gao, Liming > Sent: Wednesday, July 10, 2019 3:44 PM > To: devel@edk2.groups.io; Wang, Jian J > Cc: Leif Lindholm ; Kinney, Michael D > > Subject: RE: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule > policy and clone commands >=20 > Jian: >=20 > >-----Original Message----- > >From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of > >Wang, Jian J > >Sent: Wednesday, July 10, 2019 2:10 PM > >To: devel@edk2.groups.io > >Cc: Leif Lindholm ; Kinney, Michael D > >; Gao, Liming > >Subject: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy > and > >clone commands > > > >> v2: update wording per Leif's and others' comments > > > >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 > Here, I understand to avoid the child submodule, and the root submodule = is > allowed. > Besides, there is two spaces between EDK II contains. Please take care. >=20 No exactly. I think it's dependency chain, i.e. one submodule depends on another submodule. It's out of our control that one submodule imports other submodules in its repo. What about changing the first statement to following: Submodule is allowed to import 3rd party code into EDK II repo. But submodules that require further submodules should be avoided as possible as we can. And I'll remove the extra space here. > >+ > >+- 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 > >+``` > >+ > Please also give the update command for submodule. >=20 I'll add it. > Thanks > Liming > >+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 > > > > > >