CryptoPkg/OpensslLib: Fix the documentation about submodule update

This patch is to drop "--remote" option from the original suggested
submodule update command ("$ git submodule update --recursive
--remote") in HOWTO document.

"--remote" option will integrate changes from the upstream subproject
with the submodules's "current HEAD", instead of using the edk2
superproject's "recorded SHA-1".

It is important here for the edk2 consumers to updating the working
tree of the submodules to match the commit / release tag that the
superproject expects. So removing "--remote" option to fix this
documentation issue here.

Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Ye Ting <ting.ye@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Long Qin <qin.long@intel.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
This commit is contained in:
Long Qin 2018-04-12 10:50:30 +08:00
parent e7df35b2bc
commit a701ea0fe1
1 changed files with 1 additions and 1 deletions

View File

@ -40,7 +40,7 @@ or
And use the following combined commands to pull the remote submodule updates And use the following combined commands to pull the remote submodule updates
(e.g. Updating the new supported OpenSSL release tag): (e.g. Updating the new supported OpenSSL release tag):
$ git pull --recurse-submodules && \ $ git pull --recurse-submodules && \
git submodule update --recursive --remote git submodule update --recursive
============================================================================= =============================================================================
About process_files.pl About process_files.pl