From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 192.55.52.120, mailfrom: jian.j.wang@intel.com) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by groups.io with SMTP; Tue, 09 Jul 2019 18:50:27 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga004.jf.intel.com ([10.7.209.38]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 09 Jul 2019 18:50:26 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.63,472,1557212400"; d="scan'208";a="317211556" Received: from fmsmsx105.amr.corp.intel.com ([10.18.124.203]) by orsmga004.jf.intel.com with ESMTP; 09 Jul 2019 18:50:26 -0700 Received: from fmsmsx115.amr.corp.intel.com (10.18.116.19) by FMSMSX105.amr.corp.intel.com (10.18.124.203) with Microsoft SMTP Server (TLS) id 14.3.439.0; Tue, 9 Jul 2019 18:50:26 -0700 Received: from shsmsx154.ccr.corp.intel.com (10.239.6.54) by fmsmsx115.amr.corp.intel.com (10.18.116.19) with Microsoft SMTP Server (TLS) id 14.3.439.0; Tue, 9 Jul 2019 18:50:25 -0700 Received: from shsmsx107.ccr.corp.intel.com ([169.254.9.162]) by SHSMSX154.ccr.corp.intel.com ([169.254.7.240]) with mapi id 14.03.0439.000; Wed, 10 Jul 2019 09:50:23 +0800 From: "Wang, Jian J" To: Leif Lindholm CC: "devel@edk2.groups.io" , "Kinney, Michael D" , "Gao, Liming" Subject: Re: [PATCH 1/2] Readme.md: add submodule policy and clone commands Thread-Topic: [PATCH 1/2] Readme.md: add submodule policy and clone commands Thread-Index: AQHVNjhm5Q9Yx/4x5UiDfNm+rxoeTabDFghw Date: Wed, 10 Jul 2019 01:50:23 +0000 Message-ID: References: <20190709063601.7212-1-jian.j.wang@intel.com> <20190709063601.7212-2-jian.j.wang@intel.com> <20190709092634.thwxpq6cw7u7tocp@bivouac.eciton.net> In-Reply-To: <20190709092634.thwxpq6cw7u7tocp@bivouac.eciton.net> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiZjQyYzgwOTItOGI4MC00N2ViLWEyYjUtNGU3OGU5MTdkOGNmIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiWTVmN0JLNkNJSUVyamRiZzFVV01NNG9teXVaalVIMjdVQ09LK0MwVjhGRENHZzNwM2dCcitONUZmeHVvejE5USJ9 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 Leif, > -----Original Message----- > From: Leif Lindholm [mailto:leif.lindholm@linaro.org] > Sent: Tuesday, July 09, 2019 5:27 PM > To: Wang, Jian J > Cc: devel@edk2.groups.io; Kinney, Michael D > ; Gao, Liming > Subject: Re: [PATCH 1/2] Readme.md: add submodule policy and clone > commands >=20 > Hi Jian, >=20 > Many thanks for this. > A few comments on the text. >=20 > On Tue, Jul 09, 2019 at 02:36:00PM +0800, Jian J Wang wrote: > > 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 | 19 +++++++++++++++++++ > > 1 file changed, 19 insertions(+) > > > > diff --git a/Readme.md b/Readme.md > > index e564c6c09b..ddb4da5648 100644 > > --- a/Readme.md > > +++ b/Readme.md > > @@ -143,3 +143,22 @@ 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, submodules should be avoided in EDK II repo as > possible as we can, especially submodules required by other submodules. > Currently EDK II contains two submodules >=20 > Please wrap lines at 80 characters. > One of the benefits of markdown is that it can be easily read both as > a plain text file, and be rendered into something else (like html for > displaying on the web). >=20 I used markdown editor to do this. I didn't notice the line length. I'll wr= ap it. > > + > > +- CryptoPkg/Library/OpensslLib/openssl > > +- ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3 > > + > > +The later one is actually required by previous one. It's inevitable in > openssl-1.1.1 (since stable201905) for floating point parameter conversio= n, > but should be dropped once there's no such need in future release of > openssl. >=20 > "later" -> "latter" when referring to items in an enumeration > (interesting quirk of English) >=20 Thanks for catching this. I might have used this wrong word for years:( > > + > > +Note: When cloning submodule repos, '--recursive' option is not > recommended. EDK II itself will not use any code/feature from submodules > in above submodules. '--recursive' might cause failure in cloning behind > proxy. >=20 > I wouldn't say "behind proxy". It may fail because it adds additional > servers that must be reachable in order for the clone to succeed. >=20 > So we could replace the last sentence above with something like: > "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." >=20 > I would also prefer to move this "Note:" to immediately below the > command example: You're right. I'll use your version instead in v2. Thanks for the comments. Regards, Jian >=20 > > + > > +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 > > +``` > > + >=20 > ("Note:" here.) >=20 > / > Leif >=20 > > -- > > 2.17.1.windows.2 > >