[PATCH v3 0/2] Add edk2 submodule policy

[PATCH v3 0/2] Add edk2 submodule policy

[Wang, Jian J]

>v3 change
>  [1/2] a. change wording about submodule per Liming's comment.
>        b. add more steps to do submodule update per Mike's comment.
>        c. add commands for update of submodule
>  [2/2] no changes.

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                                     | 39 +++++++++++++++++++
 2 files changed, 41 insertions(+), 16 deletions(-)

-- 
2.17.1.windows.2

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

[Wang, Jian J]

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>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>
---
 Readme.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/Readme.md b/Readme.md
index 7c873759a5..27e4ce0771 100644
--- a/Readme.md
+++ b/Readme.md
@@ -140,3 +140,42 @@ 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
+
+Submodule in EDK II is allowed but submodule chain should be avoided
+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 steps of git
+command
+
+```
+$ git clone https://github.com/tianocore/edk2.git
+$ cd edk2
+$ git submodule update --init
+$ cd ..
+```
+
+If there's update for submodules, use following git commands to get the
+latest submodules code.
+
+```
+$ cd edk2
+$ git pull
+$ git submodule update
+```
+
+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 v3 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: [PATCH v3 0/2] Add edk2 submodule policy

[Liming Gao]

Jian:
  Thanks for your update. The change is good. Reviewed-by: Liming Gao <liming.gao@intel.com>

> -----Original Message-----
> From: Wang, Jian J
> Sent: Wednesday, August 14, 2019 4:15 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: [PATCH v3 0/2] Add edk2 submodule policy
> 
> >v3 change
> >  [1/2] a. change wording about submodule per Liming's comment.
> >        b. add more steps to do submodule update per Mike's comment.
> >        c. add commands for update of submodule
> >  [2/2] no changes.
> 
> 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                                     | 39 +++++++++++++++++++
>  2 files changed, 41 insertions(+), 16 deletions(-)
> 
> --
> 2.17.1.windows.2

Re: [PATCH v3 0/2] Add edk2 submodule policy

[Wang, Jian J]

Pushed at 2556350d1b..5ab96088ae

Regards,
Jian


> -----Original Message-----
> From: Gao, Liming
> Sent: Thursday, August 15, 2019 8:33 AM
> To: Wang, Jian J <jian.j.wang@intel.com>; devel@edk2.groups.io
> Cc: Leif Lindholm <leif.lindholm@linaro.org>; Kinney, Michael D
> <michael.d.kinney@intel.com>
> Subject: RE: [PATCH v3 0/2] Add edk2 submodule policy
> 
> Jian:
>   Thanks for your update. The change is good. Reviewed-by: Liming Gao
> <liming.gao@intel.com>
> 
> > -----Original Message-----
> > From: Wang, Jian J
> > Sent: Wednesday, August 14, 2019 4:15 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: [PATCH v3 0/2] Add edk2 submodule policy
> >
> > >v3 change
> > >  [1/2] a. change wording about submodule per Liming's comment.
> > >        b. add more steps to do submodule update per Mike's comment.
> > >        c. add commands for update of submodule
> > >  [2/2] no changes.
> >
> > 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                                     | 39 +++++++++++++++++++
> >  2 files changed, 41 insertions(+), 16 deletions(-)
> >
> > --
> > 2.17.1.windows.2