[ PATCH v2 0/2] Add edk2 submodule policy

[ PATCH v2 0/2] Add edk2 submodule policy

[Wang, Jian J]

https://bugzilla.tianocore.org/show_bug.cgi?id=1910

Cc: Leif Lindholm <leif.lindholm@linaro.org>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>

Jian J Wang (2):
  Readme.md: add submodule policy and clone commands
  CryptoPkg/OpensslLib: remove clone commands

 .../Library/OpensslLib/OpenSSL-HOWTO.txt      | 18 ++----------
 Readme.md                                     | 28 +++++++++++++++++++
 2 files changed, 30 insertions(+), 16 deletions(-)

-- 
2.17.1.windows.2

[ PATCH v2 1/2] Readme.md: add submodule policy and clone commands

[Wang, Jian J]

> v2: update wording per Leif's and others' comments

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1910

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 <leif.lindholm@linaro.org>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Jian J Wang <jian.j.wang@intel.com>
---
 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 <contributor@example.com>
   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

[ PATCH v2 2/2] CryptoPkg/OpensslLib: remove clone commands

[Wang, Jian J]

https://bugzilla.tianocore.org/show_bug.cgi?id=1910

edk2/Readme.md has added a section to explain the correct clone
commands for submodules. Detailed steps in the OpenSSL-HOWTO.txt
are removed to avoid any inconsistency.

Cc: Leif Lindholm <leif.lindholm@linaro.org>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Jian J Wang <jian.j.wang@intel.com>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>
---
 CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt | 18 ++----------------
 1 file changed, 2 insertions(+), 16 deletions(-)

diff --git a/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
index db45eb88d1..e52ee27b49 100644
--- a/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
+++ b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
@@ -24,22 +24,8 @@ on the cryptography.
 =============================================================================
                       HOW to Install OpenSSL for UEFI Building
 =============================================================================
-  OpenSSL repository was added as one submodule of EDKII project.
-
-  The user can use the following commands to clone both main EDKII repo and
-openssl submodule:
-  1) Add the "--recursive" flag to the git clone command:
-     $ git clone --recursive https://github.com/tianocore/edk2
-or
-  2) Manually initialize and update the submodules after the clone operation
-     on main project:
-     $ git clone https://github.com/tianocore/edk2
-     $ git submodule update --init --recursive
-
-  And use the following combined commands to pull the remote submodule updates
-(e.g. Updating the new supported OpenSSL release tag):
-     $ git pull --recurse-submodules && \
-       git submodule update --recursive
+  OpenSSL repository was added as one submodule of EDKII project. Please
+refer to edk2/Readme.md for how to clone the code.
 
 =============================================================================
                       About process_files.pl
-- 
2.17.1.windows.2

Re: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands

[Liming Gao]

Jian:

>-----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 <leif.lindholm@linaro.org>; Kinney, Michael D
><michael.d.kinney@intel.com>; Gao, Liming <liming.gao@intel.com>
>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=1910
>
>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 <leif.lindholm@linaro.org>
>Cc: Michael D Kinney <michael.d.kinney@intel.com>
>Cc: Liming Gao <liming.gao@intel.com>
>Signed-off-by: Jian J Wang <jian.j.wang@intel.com>
>---
> 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
><contributor@example.com>
>   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. 

>+
>+- 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. 

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
>
>
>

Re: [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands

[Leif Lindholm]

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 <leif.lindholm@linaro.org>

(although Liming had some further feedback)

> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1910
> 
> 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 <leif.lindholm@linaro.org>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> Signed-off-by: Jian J Wang <jian.j.wang@intel.com>
> ---
>  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 <contributor@example.com>
>    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
> 

Re: [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands

[Michael D Kinney]

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
$ cd ..

Mike

> -----Original Message-----
> From: Leif Lindholm [mailto:leif.lindholm@linaro.org]
> Sent: Wednesday, July 10, 2019 7:27 AM
> To: Wang, Jian J <jian.j.wang@intel.com>
> Cc: devel@edk2.groups.io; Kinney, Michael D
> <michael.d.kinney@intel.com>; Gao, Liming
> <liming.gao@intel.com>
> 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 <leif.lindholm@linaro.org>
> 
> (although Liming had some further feedback)
> 
> > REF:
> https://bugzilla.tianocore.org/show_bug.cgi?id=1910
> >
> > 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 <leif.lindholm@linaro.org>
> > Cc: Michael D Kinney <michael.d.kinney@intel.com>
> > Cc: Liming Gao <liming.gao@intel.com>
> > Signed-off-by: Jian J Wang <jian.j.wang@intel.com>
> > ---
> >  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
> <contributor@example.com>
> >    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
> >

Re: [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands

[Leif Lindholm]

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

I only said I reviewed it, not that the review was correct ;)

Yeah, good catch. I just mentally filtered out the clone bit.

> $ cd ..

Why would you want to leave? 

/
    Leif

> Mike
> 
> > -----Original Message-----
> > From: Leif Lindholm [mailto:leif.lindholm@linaro.org]
> > Sent: Wednesday, July 10, 2019 7:27 AM
> > To: Wang, Jian J <jian.j.wang@intel.com>
> > Cc: devel@edk2.groups.io; Kinney, Michael D
> > <michael.d.kinney@intel.com>; Gao, Liming
> > <liming.gao@intel.com>
> > 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 <leif.lindholm@linaro.org>
> > 
> > (although Liming had some further feedback)
> > 
> > > REF:
> > https://bugzilla.tianocore.org/show_bug.cgi?id=1910
> > >
> > > 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 <leif.lindholm@linaro.org>
> > > Cc: Michael D Kinney <michael.d.kinney@intel.com>
> > > Cc: Liming Gao <liming.gao@intel.com>
> > > Signed-off-by: Jian J Wang <jian.j.wang@intel.com>
> > > ---
> > >  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
> > <contributor@example.com>
> > >    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
> > >

Re: [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands

[Michael D Kinney]

> -----Original Message-----
> From: Leif Lindholm [mailto:leif.lindholm@linaro.org]
> Sent: Wednesday, July 10, 2019 10:18 AM
> To: Kinney, Michael D <michael.d.kinney@intel.com>
> Cc: Wang, Jian J <jian.j.wang@intel.com>;
> devel@edk2.groups.io; Gao, Liming <liming.gao@intel.com>
> Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule
> policy and clone commands
> 
> 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
> 
> I only said I reviewed it, not that the review was
> correct ;)
> 
> Yeah, good catch. I just mentally filtered out the clone
> bit.
> 
> > $ cd ..
> 
> 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.

> 
> /
>     Leif
> 
> > Mike
> >
> > > -----Original Message-----
> > > From: Leif Lindholm [mailto:leif.lindholm@linaro.org]
> > > Sent: Wednesday, July 10, 2019 7:27 AM
> > > To: Wang, Jian J <jian.j.wang@intel.com>
> > > Cc: devel@edk2.groups.io; Kinney, Michael D
> > > <michael.d.kinney@intel.com>; Gao, Liming
> <liming.gao@intel.com>
> > > 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 <leif.lindholm@linaro.org>
> > >
> > > (although Liming had some further feedback)
> > >
> > > > REF:
> > > https://bugzilla.tianocore.org/show_bug.cgi?id=1910
> > > >
> > > > 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 <leif.lindholm@linaro.org>
> > > > Cc: Michael D Kinney <michael.d.kinney@intel.com>
> > > > Cc: Liming Gao <liming.gao@intel.com>
> > > > Signed-off-by: Jian J Wang <jian.j.wang@intel.com>
> > > > ---
> > > >  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
> > > <contributor@example.com>
> > > >    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
> > > >

Re: [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands

[Leif Lindholm]

On Wed, Jul 10, 2019 at 05:28:27PM +0000, Kinney, Michael D wrote:
> 
> 
> > -----Original Message-----
> > From: Leif Lindholm [mailto:leif.lindholm@linaro.org]
> > Sent: Wednesday, July 10, 2019 10:18 AM
> > To: Kinney, Michael D <michael.d.kinney@intel.com>
> > Cc: Wang, Jian J <jian.j.wang@intel.com>;
> > devel@edk2.groups.io; Gao, Liming <liming.gao@intel.com>
> > Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule
> > policy and clone commands
> > 
> > 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
> > 
> > I only said I reviewed it, not that the review was
> > correct ;)
> > 
> > Yeah, good catch. I just mentally filtered out the clone
> > bit.
> > 
> > > $ cd ..
> > 
> > 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.

OK then :)

/
    Leif

> 
> > 
> > /
> >     Leif
> > 
> > > Mike
> > >
> > > > -----Original Message-----
> > > > From: Leif Lindholm [mailto:leif.lindholm@linaro.org]
> > > > Sent: Wednesday, July 10, 2019 7:27 AM
> > > > To: Wang, Jian J <jian.j.wang@intel.com>
> > > > Cc: devel@edk2.groups.io; Kinney, Michael D
> > > > <michael.d.kinney@intel.com>; Gao, Liming
> > <liming.gao@intel.com>
> > > > 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 <leif.lindholm@linaro.org>
> > > >
> > > > (although Liming had some further feedback)
> > > >
> > > > > REF:
> > > > https://bugzilla.tianocore.org/show_bug.cgi?id=1910
> > > > >
> > > > > 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 <leif.lindholm@linaro.org>
> > > > > Cc: Michael D Kinney <michael.d.kinney@intel.com>
> > > > > Cc: Liming Gao <liming.gao@intel.com>
> > > > > Signed-off-by: Jian J Wang <jian.j.wang@intel.com>
> > > > > ---
> > > > >  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
> > > > <contributor@example.com>
> > > > >    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
> > > > >

Re: [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands

[Wang, Jian J]

Mike,

> -----Original Message-----
> From: Kinney, Michael D
> Sent: Thursday, July 11, 2019 1:28 AM
> To: Leif Lindholm <leif.lindholm@linaro.org>; Kinney, Michael D
> <michael.d.kinney@intel.com>
> Cc: Wang, Jian J <jian.j.wang@intel.com>; devel@edk2.groups.io; Gao,
> Liming <liming.gao@intel.com>
> Subject: RE: [ PATCH v2 1/2] Readme.md: add submodule policy and clone
> commands
> 
> 
> 
> > -----Original Message-----
> > From: Leif Lindholm [mailto:leif.lindholm@linaro.org]
> > Sent: Wednesday, July 10, 2019 10:18 AM
> > To: Kinney, Michael D <michael.d.kinney@intel.com>
> > Cc: Wang, Jian J <jian.j.wang@intel.com>;
> > devel@edk2.groups.io; Gao, Liming <liming.gao@intel.com>
> > Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule
> > policy and clone commands
> >
> > 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
> >
> > I only said I reviewed it, not that the review was
> > correct ;)
> >
> > Yeah, good catch. I just mentally filtered out the clone
> > bit.
> >
> > > $ cd ..
> >
> > 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.
> 

Thanks for catching the issue. I'll update the edk2/Readme.md. 
Then the edk2-platforms/Readme.md has the same issue. It will be
updated as well.

Regards,
Jian

> >
> > /
> >     Leif
> >
> > > Mike
> > >
> > > > -----Original Message-----
> > > > From: Leif Lindholm [mailto:leif.lindholm@linaro.org]
> > > > Sent: Wednesday, July 10, 2019 7:27 AM
> > > > To: Wang, Jian J <jian.j.wang@intel.com>
> > > > Cc: devel@edk2.groups.io; Kinney, Michael D
> > > > <michael.d.kinney@intel.com>; Gao, Liming
> > <liming.gao@intel.com>
> > > > 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 <leif.lindholm@linaro.org>
> > > >
> > > > (although Liming had some further feedback)
> > > >
> > > > > REF:
> > > > https://bugzilla.tianocore.org/show_bug.cgi?id=1910
> > > > >
> > > > > 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 <leif.lindholm@linaro.org>
> > > > > Cc: Michael D Kinney <michael.d.kinney@intel.com>
> > > > > Cc: Liming Gao <liming.gao@intel.com>
> > > > > Signed-off-by: Jian J Wang <jian.j.wang@intel.com>
> > > > > ---
> > > > >  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
> > > > <contributor@example.com>
> > > > >    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
> > > > >

Re: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands

[Wang, Jian J]

Liming,

> -----Original Message-----
> From: Gao, Liming
> Sent: Wednesday, July 10, 2019 3:44 PM
> To: devel@edk2.groups.io; Wang, Jian J <jian.j.wang@intel.com>
> Cc: Leif Lindholm <leif.lindholm@linaro.org>; Kinney, Michael D
> <michael.d.kinney@intel.com>
> Subject: RE: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule
> policy and clone commands
> 
> Jian:
> 
> >-----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 <leif.lindholm@linaro.org>; Kinney, Michael D
> ><michael.d.kinney@intel.com>; Gao, Liming <liming.gao@intel.com>
> >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=1910
> >
> >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 <leif.lindholm@linaro.org>
> >Cc: Michael D Kinney <michael.d.kinney@intel.com>
> >Cc: Liming Gao <liming.gao@intel.com>
> >Signed-off-by: Jian J Wang <jian.j.wang@intel.com>
> >---
> > 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
> ><contributor@example.com>
> >   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.
> 

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.
> 

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
> >
> >
> >

[off-topic] Readme.md: add submodule policy and clone commands

[Laszlo Ersek]

(off-topic, as marked in the subject)

On 07/10/19 19:17, Leif Lindholm wrote:
> 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
> 
> I only said I reviewed it, not that the review was correct ;)
> 
> Yeah, good catch. I just mentally filtered out the clone bit.
> 
>> $ cd ..
> 
> Why would you want to leave? 

Heh, that's a good one :) Reminds me of a blog post or similar where the
question was posed (tongue-in-cheek of course), "why boot at all? UEFI
gives you everything!" :)

Thanks!
Laszlo