Readme.md: remove positional references from submodule description

[mirror_edk2.git] / Readme.md

diff --git a/Readme.md b/Readme.md
index 1feba1607504f6ccf6ecbdaa351a889ba1488c87..9bf60bede8ec1dffa81d0cc0c72470818539768a 100644 (file)
--- a/Readme.md
+++ b/Readme.md
@@ -12,10 +12,10 @@ contains the following components that are covered by additional licenses:
 * [MdeModulePkg/Library/LzmaCustomDecompressLib](MdeModulePkg/Library/LzmaCustomDecompressLib/LZMA-SDK-README.txt)\r
 * [IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/Sdk](IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/LZMA-SDK-README.txt)\r
 * [BaseTools/Source/C/VfrCompile/Pccts](BaseTools/Source/C/VfrCompile/Pccts/RIGHTS)\r
-* [EdkCompatibilityPkg/Other/Maintained/Tools/Pccts](EdkCompatibilityPkg/Other/Maintained/Tools/Pccts/README)\r
 * [MdeModulePkg/Universal/RegularExpressionDxe/Oniguruma](MdeModulePkg/Universal/RegularExpressionDxe/Oniguruma/README)\r
 * [OvmfPkg](OvmfPkg/License.txt)\r
-* [CryptoPkg/Library/OpensslLib/openssl](CryptoPkg/Library/OpensslLib/openssl/LICENSE)\r
+* [CryptoPkg/Library/OpensslLib/openssl](https://github.com/openssl/openssl/blob/50eaac9f3337667259de725451f201e784599687/LICENSE)\r
+* [ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3](https://github.com/ucb-bar/berkeley-softfloat-3/blob/b64af41c3276f97f0e181920400ee056b9c88037/COPYING.txt)\r
 \r
 The EDK II Project is composed of packages.  The maintainers for each package\r
 are listed in [Maintainers.txt](Maintainers.txt).\r
@@ -28,9 +28,6 @@ are listed in [Maintainers.txt](Maintainers.txt).
 * [TianoCore Bugzilla](https://bugzilla.tianocore.org)\r
 * [How To Contribute](https://github.com/tianocore/tianocore.github.io/wiki/How-To-Contribute)\r
 * [Release Planning](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Release-Planning)\r
-* [UDK2017](https://github.com/tianocore/edk2/releases/tag/vUDK2017)\r
-* [UDK2018](https://github.com/tianocore/edk2/releases/tag/vUDK2018)\r
-* [edk2-stable201811](https://github.com/tianocore/edk2/releases/tag/edk2-stable201811)\r
 \r
 # Code Contributions\r
 To make a contribution to a TianoCore project, follow these steps.\r
@@ -143,3 +140,42 @@ Signed-off-by: Contributor Name <contributor@example.com>
   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
+\r
+# Submodules\r
+\r
+Submodule in EDK II is allowed but submodule chain should be avoided\r
+as possible as we can. Currently EDK II contains the following submodules\r
+\r
+- CryptoPkg/Library/OpensslLib/openssl\r
+- ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3\r
+\r
+ArmSoftFloatLib is actually required by OpensslLib. 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
+\r
+To get a full, buildable EDK II repository, use following steps of git\r
+command\r
+\r
+```\r
+$ git clone https://github.com/tianocore/edk2.git\r
+$ cd edk2\r
+$ git submodule update --init\r
+$ cd ..\r
+```\r
+\r
+If there's update for submodules, use following git commands to get the\r
+latest submodules code.\r
+\r
+```\r
+$ cd edk2\r
+$ git pull\r
+$ git submodule update\r
+```\r
+\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
+use.\r