1. Patchew
  2. EDK2
  3. [edk2] [PATCH v2 0/2] Update OpenSSL version to 1.1.0h
  4. View patch

[edk2] [PATCH v2 1/2] CryptoPkg/OpensslLib: Fix the documentation about submodule update

Long Qin posted 2 patches 7 years, 10 months ago
[edk2] [PATCH v2 1/2] CryptoPkg/OpensslLib: Fix the documentation about submodule update
Posted by Long Qin 7 years, 10 months ago 
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 wrong here for the edk2
consumers to updating the working tree of the submodules to match the
commit / release tag that the superproject expects.

Removing "--remote" option to fix the 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>
---
 CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
index ac63d4c077..36f8e711dd 100644
--- a/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
+++ b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
@@ -40,7 +40,7 @@ or
   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 --remote
+       git submodule update --recursive
 
 =============================================================================
                       About process_files.pl
-- 
2.16.1.windows.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] [PATCH v2 1/2] CryptoPkg/OpensslLib: Fix the documentation about submodule update
Posted by Laszlo Ersek 7 years, 10 months ago 
Hello Qin,

On 04/12/18 05:08, Long Qin wrote:
> 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 wrong here for the edk2

The commit message makes sense, and the patch is good, but I think
there's a significant typo in the commit message.

Namely, the word "wrong" is wrong :) Instead, it should be "important".

Or else, "it is the goal for the edk2 consumes to ...".

Do you agree?

(I'll come to the second patch sometime later.)

Thanks!
Laszlo

> consumers to updating the working tree of the submodules to match the
> commit / release tag that the superproject expects.
> 
> Removing "--remote" option to fix the 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>
> ---
>  CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
> index ac63d4c077..36f8e711dd 100644
> --- a/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
> +++ b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
> @@ -40,7 +40,7 @@ or
>    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 --remote
> +       git submodule update --recursive
>  
>  =============================================================================
>                        About process_files.pl
> 

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] [PATCH v2 1/2] CryptoPkg/OpensslLib: Fix the documentation about submodule update
Posted by Long, Qin 7 years, 10 months ago 
Ah, "it's wrong here" means "the existence of "--remote" in original suggested command is wrong". 
"It's important" looks also make sense to address the "update" goal.  I can update that, if old message will cause confusion.


Best Regards & Thanks,
LONG, Qin

-----Original Message-----
From: Laszlo Ersek [mailto:lersek@redhat.com] 
Sent: Thursday, April 12, 2018 5:56 PM
To: Long, Qin <qin.long@intel.com>; Ye, Ting <ting.ye@intel.com>
Cc: edk2-devel@lists.01.org
Subject: Re: [PATCH v2 1/2] CryptoPkg/OpensslLib: Fix the documentation about submodule update

Hello Qin,

On 04/12/18 05:08, Long Qin wrote:
> 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 wrong here for the edk2

The commit message makes sense, and the patch is good, but I think there's a significant typo in the commit message.

Namely, the word "wrong" is wrong :) Instead, it should be "important".

Or else, "it is the goal for the edk2 consumes to ...".

Do you agree?

(I'll come to the second patch sometime later.)

Thanks!
Laszlo

> consumers to updating the working tree of the submodules to match the 
> commit / release tag that the superproject expects.
> 
> Removing "--remote" option to fix the 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>
> ---
>  CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt 
> b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
> index ac63d4c077..36f8e711dd 100644
> --- a/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
> +++ b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
> @@ -40,7 +40,7 @@ or
>    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 --remote
> +       git submodule update --recursive
>  
>  =============================================================================
>                        About process_files.pl
> 

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] [PATCH v2 1/2] CryptoPkg/OpensslLib: Fix the documentation about submodule update
Posted by Laszlo Ersek 7 years, 10 months ago 
On 04/12/18 12:03, Long, Qin wrote:
> 
> Ah, "it's wrong here" means "the existence of "--remote" in original suggested command is wrong". 
> "It's important" looks also make sense to address the "update" goal.  I can update that, if old message will cause confusion.

Ah, you used "for" in the sense of "because". :)

Yup, please clarify the commit message a little bit, I was indeed
confused by it.

Thanks!
Laszlo

> 
> 
> Best Regards & Thanks,
> LONG, Qin
> 
> -----Original Message-----
> From: Laszlo Ersek [mailto:lersek@redhat.com] 
> Sent: Thursday, April 12, 2018 5:56 PM
> To: Long, Qin <qin.long@intel.com>; Ye, Ting <ting.ye@intel.com>
> Cc: edk2-devel@lists.01.org
> Subject: Re: [PATCH v2 1/2] CryptoPkg/OpensslLib: Fix the documentation about submodule update
> 
> Hello Qin,
> 
> On 04/12/18 05:08, Long Qin wrote:
>> 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 wrong here for the edk2
> 
> The commit message makes sense, and the patch is good, but I think there's a significant typo in the commit message.
> 
> Namely, the word "wrong" is wrong :) Instead, it should be "important".
> 
> Or else, "it is the goal for the edk2 consumes to ...".
> 
> Do you agree?
> 
> (I'll come to the second patch sometime later.)
> 
> Thanks!
> Laszlo
> 
>> consumers to updating the working tree of the submodules to match the 
>> commit / release tag that the superproject expects.
>>
>> Removing "--remote" option to fix the 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>
>> ---
>>  CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt 
>> b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
>> index ac63d4c077..36f8e711dd 100644
>> --- a/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
>> +++ b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
>> @@ -40,7 +40,7 @@ or
>>    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 --remote
>> +       git submodule update --recursive
>>  
>>  =============================================================================
>>                        About process_files.pl
>>
> 

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] [PATCH v2 1/2] CryptoPkg/OpensslLib: Fix the documentation about submodule update
Posted by Laszlo Ersek 7 years, 10 months ago 
On 04/12/18 12:03, Long, Qin wrote:
> 
> Ah, "it's wrong here" means "the existence of "--remote" in original suggested command is wrong". 
> "It's important" looks also make sense to address the "update" goal.  I can update that, if old message will cause confusion.

With the commit message clarified:

Reviewed-by: Laszlo Ersek <lersek@redhat.com>

Thanks
Laszlo

> 
> -----Original Message-----
> From: Laszlo Ersek [mailto:lersek@redhat.com] 
> Sent: Thursday, April 12, 2018 5:56 PM
> To: Long, Qin <qin.long@intel.com>; Ye, Ting <ting.ye@intel.com>
> Cc: edk2-devel@lists.01.org
> Subject: Re: [PATCH v2 1/2] CryptoPkg/OpensslLib: Fix the documentation about submodule update
> 
> Hello Qin,
> 
> On 04/12/18 05:08, Long Qin wrote:
>> 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 wrong here for the edk2
> 
> The commit message makes sense, and the patch is good, but I think there's a significant typo in the commit message.
> 
> Namely, the word "wrong" is wrong :) Instead, it should be "important".
> 
> Or else, "it is the goal for the edk2 consumes to ...".
> 
> Do you agree?
> 
> (I'll come to the second patch sometime later.)
> 
> Thanks!
> Laszlo
> 
>> consumers to updating the working tree of the submodules to match the 
>> commit / release tag that the superproject expects.
>>
>> Removing "--remote" option to fix the 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>
>> ---
>>  CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt 
>> b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
>> index ac63d4c077..36f8e711dd 100644
>> --- a/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
>> +++ b/CryptoPkg/Library/OpensslLib/OpenSSL-HOWTO.txt
>> @@ -40,7 +40,7 @@ or
>>    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 --remote
>> +       git submodule update --recursive
>>  
>>  =============================================================================
>>                        About process_files.pl
>>
> 
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel
> 

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Patchew 2.1-devel-b67e4c2

© 2016 - 2026 Red Hat, Inc.