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.20, mailfrom: michael.d.kinney@intel.com) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by groups.io with SMTP; Mon, 26 Aug 2019 15:11:24 -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 orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 26 Aug 2019 15:11:24 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.64,433,1559545200"; d="scan'208,217";a="197158226" Received: from orsmsx110.amr.corp.intel.com ([10.22.240.8]) by fmsmga001.fm.intel.com with ESMTP; 26 Aug 2019 15:11:23 -0700 Received: from orsmsx161.amr.corp.intel.com (10.22.240.84) by ORSMSX110.amr.corp.intel.com (10.22.240.8) with Microsoft SMTP Server (TLS) id 14.3.439.0; Mon, 26 Aug 2019 15:11:22 -0700 Received: from orsmsx113.amr.corp.intel.com ([169.254.9.198]) by ORSMSX161.amr.corp.intel.com ([169.254.4.172]) with mapi id 14.03.0439.000; Mon, 26 Aug 2019 15:11:22 -0700 From: "Michael D Kinney" To: "devel@edk2.groups.io" , "afish@apple.com" , "Gao, Liming" , "Kinney, Michael D" CC: "rebecca@bsdio.com" Subject: Re: [edk2-devel] git submodule update --init --recursive Thread-Topic: [edk2-devel] git submodule update --init --recursive Thread-Index: AQHVWfMoHeXxTiwMhUWHzbwVYYYZIacJxEEAgAOA+4CAAS9CgP//jVqg Date: Mon, 26 Aug 2019 22:11:21 +0000 Message-ID: References: <83E89A1F-25F0-40ED-BE33-6843030DFEE4@apple.com> <35027f0c-51f3-a37a-c94a-b3df084c3981@bsdio.com> <4A89E2EF3DFEDB4C8BFDE51014F606A14E4DC1E6@SHSMSX104.ccr.corp.intel.com> <0ED23C22-D224-40E0-BB57-ACA8F1ABCEA1@apple.com> In-Reply-To: <0ED23C22-D224-40E0-BB57-ACA8F1ABCEA1@apple.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows dlp-version: 11.2.0.6 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: multipart/alternative; boundary="_000_E92EE9817A31E24EB0585FDF735412F5B9DA36B8ORSMSX113amrcor_" --_000_E92EE9817A31E24EB0585FDF735412F5B9DA36B8ORSMSX113amrcor_ Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Andrew, I agree the documentation for this should be in the same section as the cl= one requirements. This operation is not always required. Right now, if a platform does not = use OpenSSL in CryptoPkg, then the submodule operation can be skipped. The documentation should let the developer know when it is required. Mike From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of Andr= ew Fish via Groups.Io Sent: Monday, August 26, 2019 2:59 PM To: Gao, Liming Cc: devel@edk2.groups.io; rebecca@bsdio.com Subject: Re: [edk2-devel] git submodule update --init --recursive Liming, I see the usage of Submodules is documented at the end of the Readme.md. I= would not think of going to a Submodules section to figure out how to get = started or clone the repo. I did not think of reading the full Readme.md as most of it is about "How= to Contribute to" not how to use the repo. >>From TianoCore.org I followed this path: https://www.tianocore.org/getting-started.html https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-with= -EDK-II https://github.com/tianocore/tianocore.github.io/wiki/Windows-systems or https://github.com/tianocore/tianocore.github.io/wiki/Common-instructions-= for-Unix The git clone instructions don't include the "git submodule update --init"= instructions and the OVMF build failed. bash$ mkdir ~/src bash$ cd ~/src bash$ git clone https://github.com/tianocore/edk2 Thanks, Andrew Fish On Aug 25, 2019, at 8:54 PM, Gao, Liming > wrote: edk2\Readme.md Submodules section gives the command to update edk2 project= . Thanks Liming -----Original Message----- From: devel@edk2.groups.io [mailto:devel@edk2= .groups.io] On Behalf Of rebecca@bsdio.com Sent: Saturday, August 24, 2019 6:24 AM To: devel@edk2.groups.io; afish@apple.com Subject: Re: [edk2-devel] git submodule update --init --recursive On 2019-08-23 14:41, Andrew Fish via Groups.Io wrote: I was following the instructions on how to build OVMF and my build failed.= It looks like the reason it failed was because I did not do a `git submodule update --init --recursive`. It would be good if we could make how to clone= the edk2 instructions a bit more obvious. I think we came to the conclusion that "--recursive" isn't needed. But I've found that there are cases where "--force" is required to make sure git checks out a submodule correctly. -- Rebecca Cran --_000_E92EE9817A31E24EB0585FDF735412F5B9DA36B8ORSMSX113amrcor_ Content-Type: text/html; charset="us-ascii" Content-Transfer-Encoding: quoted-printable

Andrew,

 

I agree the documentation for this should be in the same secti= on as the clone requirements.

 

This operation is not always required.  Right now, if a platform does not use OpenSSL in CryptoPkg, then the submodule operation can be skipped.

 

The documentation should let the developer know when it is req= uired.

 

Mike

 

From: = devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of Andrew Fish via Groups.= Io
Sent: Monday, August 26, 2019 2:59 PM
To: Gao, Liming <liming.gao@intel.com>
Cc: devel@edk2.groups.io; rebecca@bsdio.com
Subject: Re: [edk2-devel] git submodule update --init --recursive

 

Liming,

 

I see the usage of Submodules is documented at the end of = the Readme.md. I would not think of going to a Submodules section to figure= out how to get started or clone the repo. 

 

I did not think of reading the full  Readme.md a= s most of it is about "How to Contribute to" not how to use the r= epo. 

 

From TianoCore.org I followed this path:

 

or

 

 

The git clone instructions don't include the "git sub= module update --init" instructions and the OVMF build failed. 

 

bash$ mkdir ~/src
bash$ cd ~/src
bash$ git clone https://github.com/tianocore/edk2<=
/pre>



 






Thanks,






 






Andrew Fish

















On Aug 25, 2019, at 8:54 PM, Gao, Liming <liming.gao@intel.com> wrote:




 






edk2\Readme.md Submodules section gives the command to upd=
ate edk2 project.




Thanks

Liming








-----Original Message-----
From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On B=
ehalf Of

rebecca@bsdio.com

Sent: Saturday, August 24, 2019 6:24 AM

To: devel@edk2.groups.io; 
afish@apple.com

Subject: Re: [edk2-devel] git submodule update --init --recursive



On 2019-08-23 14:41, Andrew Fish via Groups.Io wrote:








I was following the instructions on how to build OVMF and =
my build failed. It




looks like the reason it fa=
iled was because I did not do a `git submodule

update --init --recursive`. It would be good if we could make how to clone=
 the

edk2 instructions a bit more obvious.





I think we came to the conclusion that "--recursive" isn't neede=
d. But

I've found that there are cases where "--force" is required to m=
ake sure

git checks out a submodule correctly.





--

Rebecca Cran










 










 

--_000_E92EE9817A31E24EB0585FDF735412F5B9DA36B8ORSMSX113amrcor_--