add submodule policy and clone commands
authorJian J Wang <>
Mon, 8 Jul 2019 09:02:42 +0000 (17:02 +0800)
committerJian J Wang <>
Thu, 15 Aug 2019 01:56:37 +0000 (09:56 +0800)

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 <>
Reviewed-by: Leif Lindholm <>
Reviewed-by: Liming Gao <>

index 7c87375..27e4ce0 100644 (file)
--- a/
+++ b/
@@ -140,3 +140,42 @@ Signed-off-by: Contributor Name <>
   the change.  Each line should be less than ~70 characters.\r
 * `Signed-off-by` is the contributor's signature identifying them\r
   by their real/legal name and their email address.\r
+# Submodules\r
+Submodule in EDK II is allowed but submodule chain should be avoided\r
+as possible as we can. Currently EDK II contains two submodules\r
+- CryptoPkg/Library/OpensslLib/openssl\r
+- ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3\r
+The latter one is actually required by previous one. It's inevitable\r
+in openssl-1.1.1 (since stable201905) for floating point parameter\r
+conversion, but should be dropped once there's no such need in future\r
+release of openssl.\r
+To get a full, buildable EDK II repository, use following steps of git\r
+$ git clone\r
+$ cd edk2\r
+$ git submodule update --init\r
+$ cd ..\r
+If there's update for submodules, use following git commands to get the\r
+latest submodules code.\r
+$ cd edk2\r
+$ git pull\r
+$ git submodule update\r
+Note: When cloning submodule repos, '--recursive' option is not\r
+recommended. EDK II itself will not use any code/feature from\r
+submodules in above submodules. So using '--recursive' adds a\r
+dependency on being able to reach servers we do not actually want\r
+any code from, as well as needlessly downloading code we will not\r