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

[Wang, Jian J]

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 at linaro.org>
Cc: Michael D Kinney <michael.d.kinney at intel.com>
Cc: Liming Gao <liming.gao at intel.com>
Signed-off-by: Jian J Wang <jian.j.wang at intel.com>
---
 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 <contributor at 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, 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
+
+- 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 conversion, but should be dropped once there's no such need in future release of openssl.
+
+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.
+
+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
+```
+
-- 
2.17.1.windows.2


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#43423): https://edk2.groups.io/g/devel/message/43423
Mute This Topic: https://groups.io/mt/32402918/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-