[PATCH] CryptoPkg: Fix various typos

[PATCH] CryptoPkg: Fix various typos

[Antoine Coeur]

Fix various typos in CryptoPkg.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Coeur <coeur@gmx.fr>
---
 CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c         | 2 +-
 CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c b/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
index d63c23df09..540c5715cb 100644
--- a/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
+++ b/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
@@ -142,7 +142,7 @@ IMPLEMENT_ASN1_FUNCTIONS (TS_TST_INFO)
   @param[in]  Asn1Time         Pointer to the ASN.1 GeneralizedTime to be converted.
   @param[out] SigningTime      Return the corresponding EFI Time.
 
-  @retval  TRUE   The time convertion succeeds.
+  @retval  TRUE   The time conversion succeeds.
   @retval  FALSE  Invalid parameters.
 
 **/
diff --git a/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c b/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
index 9510a4a383..929e3fcd1e 100644
--- a/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
+++ b/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
@@ -84,14 +84,14 @@ QuickSortWorker (
     }
   }
   //
-  // Swap pivot to it's final position (NextSwapLocaiton)
+  // Swap pivot to it's final position (NextSwapLocation)
   //
   CopyMem (Buffer, Pivot, ElementSize);
   CopyMem (Pivot, (UINT8 *)BufferToSort + (NextSwapLocation * ElementSize), ElementSize);
   CopyMem ((UINT8 *)BufferToSort + (NextSwapLocation * ElementSize), Buffer, ElementSize);
 
   //
-  // Now recurse on 2 paritial lists.  Neither of these will have the 'pivot' element.
+  // Now recurse on 2 partial lists.  Neither of these will have the 'pivot' element.
   // IE list is sorted left half, pivot element, sorted right half...
   //
   QuickSortWorker (
-- 
2.17.2 (Apple Git-113)

Re: [PATCH] CryptoPkg: Fix various typos

[Philippe Mathieu-Daudé]

Hi Antoine,

On 2/6/19 6:24 PM, Antoine Coeur wrote:
> Fix various typos in CryptoPkg.
> 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Coeur <coeur@gmx.fr>
> ---
>  CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c         | 2 +-
>  CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c | 4 ++--
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c b/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
> index d63c23df09..540c5715cb 100644
> --- a/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
> +++ b/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
> @@ -142,7 +142,7 @@ IMPLEMENT_ASN1_FUNCTIONS (TS_TST_INFO)
>    @param[in]  Asn1Time         Pointer to the ASN.1 GeneralizedTime to be converted.
>    @param[out] SigningTime      Return the corresponding EFI Time.
>  
> -  @retval  TRUE   The time convertion succeeds.
> +  @retval  TRUE   The time conversion succeeds.

The typos are indeed fixed, so:
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>

However reading this description makes me suspicious, I'd have written
"The time convertion succeeded.", but I'm not native English speaker so
I'll let someone with more insurance opinate.

Regards,

Phil.

>    @retval  FALSE  Invalid parameters.
>  
>  **/
> diff --git a/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c b/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
> index 9510a4a383..929e3fcd1e 100644
> --- a/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
> +++ b/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
> @@ -84,14 +84,14 @@ QuickSortWorker (
>      }
>    }
>    //
> -  // Swap pivot to it's final position (NextSwapLocaiton)
> +  // Swap pivot to it's final position (NextSwapLocation)
>    //
>    CopyMem (Buffer, Pivot, ElementSize);
>    CopyMem (Pivot, (UINT8 *)BufferToSort + (NextSwapLocation * ElementSize), ElementSize);
>    CopyMem ((UINT8 *)BufferToSort + (NextSwapLocation * ElementSize), Buffer, ElementSize);
>  
>    //
> -  // Now recurse on 2 paritial lists.  Neither of these will have the 'pivot' element.
> +  // Now recurse on 2 partial lists.  Neither of these will have the 'pivot' element.
>    // IE list is sorted left half, pivot element, sorted right half...
>    //
>    QuickSortWorker (
> 

Re: [PATCH] CryptoPkg: Fix various typos

[Wang, Jian J]

Coeur,


> -----Original Message-----
> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of
> Antoine Coeur
> Sent: Thursday, February 07, 2019 1:25 AM
> To: edk2-devel@lists.01.org
> Subject: [edk2] [PATCH] CryptoPkg: Fix various typos
> 
> Fix various typos in CryptoPkg.
> 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Coeur <coeur@gmx.fr>
> ---
>  CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c         | 2 +-
>  CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c | 4 ++--
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
> b/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
> index d63c23df09..540c5715cb 100644
> --- a/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
> +++ b/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
> @@ -142,7 +142,7 @@ IMPLEMENT_ASN1_FUNCTIONS (TS_TST_INFO)
>    @param[in]  Asn1Time         Pointer to the ASN.1 GeneralizedTime to be
> converted.
>    @param[out] SigningTime      Return the corresponding EFI Time.
> 
> -  @retval  TRUE   The time convertion succeeds.
> +  @retval  TRUE   The time conversion succeeds.
>    @retval  FALSE  Invalid parameters.
> 
>  **/
> diff --git a/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
> b/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
> index 9510a4a383..929e3fcd1e 100644
> --- a/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
> +++ b/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
> @@ -84,14 +84,14 @@ QuickSortWorker (
>      }
>    }
>    //
> -  // Swap pivot to it's final position (NextSwapLocaiton)
> +  // Swap pivot to it's final position (NextSwapLocation)

Thanks for the fixes. Please also change it's to its.

Regards,
Jian

>    //
>    CopyMem (Buffer, Pivot, ElementSize);
>    CopyMem (Pivot, (UINT8 *)BufferToSort + (NextSwapLocation * ElementSize),
> ElementSize);
>    CopyMem ((UINT8 *)BufferToSort + (NextSwapLocation * ElementSize), Buffer,
> ElementSize);
> 
>    //
> -  // Now recurse on 2 paritial lists.  Neither of these will have the 'pivot'
> element.
> +  // Now recurse on 2 partial lists.  Neither of these will have the 'pivot' element.
>    // IE list is sorted left half, pivot element, sorted right half...
>    //
>    QuickSortWorker (
> --
> 2.17.2 (Apple Git-113)
> 
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel

Re: [PATCH] CryptoPkg: Fix various typos

[Ryszard Knop]

Hi Philippe, Antoine,

On Wed, 2019-02-06 at 23:30 +0100, Philippe Mathieu-Daudé wrote:
> Hi Antoine,
> 
> On 2/6/19 6:24 PM, Antoine Coeur wrote:
> > Fix various typos in CryptoPkg.
> > 
> > Contributed-under: TianoCore Contribution Agreement 1.1
> > Signed-off-by: Coeur <coeur@gmx.fr>
> > ---
> >  CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c         | 2 +-
> >  CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c | 4 ++--
> >  2 files changed, 3 insertions(+), 3 deletions(-)
> > 
> > diff --git a/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
> > b/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
> > index d63c23df09..540c5715cb 100644
> > --- a/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
> > +++ b/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
> > @@ -142,7 +142,7 @@ IMPLEMENT_ASN1_FUNCTIONS (TS_TST_INFO)
> >    @param[in]  Asn1Time         Pointer to the ASN.1
> > GeneralizedTime to be converted.
> >    @param[out] SigningTime      Return the corresponding EFI Time.
> >  
> > -  @retval  TRUE   The time convertion succeeds.
> > +  @retval  TRUE   The time conversion succeeds.
> 
> The typos are indeed fixed, so:
> Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
> 
> However reading this description makes me suspicious, I'd have
> written
> "The time convertion succeeded.", but I'm not native English speaker
> so
> I'll let someone with more insurance opinate.

I'm not a native speaker either, but I'd write "conversion" as well.
(Like revert -> reversion, subvert -> subversion, avert -> aversion,
and so on.)

> 
> Regards,
> 
> Phil.
> 
> >    @retval  FALSE  Invalid parameters.
> >  
> >  **/
> > diff --git a/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
> > b/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
> > index 9510a4a383..929e3fcd1e 100644
> > --- a/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
> > +++ b/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
> > @@ -84,14 +84,14 @@ QuickSortWorker (
> >      }
> >    }
> >    //
> > -  // Swap pivot to it's final position (NextSwapLocaiton)
> > +  // Swap pivot to it's final position (NextSwapLocation)
> >    //
> >    CopyMem (Buffer, Pivot, ElementSize);
> >    CopyMem (Pivot, (UINT8 *)BufferToSort + (NextSwapLocation *
> > ElementSize), ElementSize);
> >    CopyMem ((UINT8 *)BufferToSort + (NextSwapLocation *
> > ElementSize), Buffer, ElementSize);
> >  
> >    //
> > -  // Now recurse on 2 paritial lists.  Neither of these will have
> > the 'pivot' element.
> > +  // Now recurse on 2 partial lists.  Neither of these will have
> > the 'pivot' element.
> >    // IE list is sorted left half, pivot element, sorted right
> > half...
> >    //
> >    QuickSortWorker (
> > 
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel

Re: [PATCH] CryptoPkg: Fix various typos

[Philippe Mathieu-Daudé]

On 2/7/19 2:04 PM, Ryszard Knop wrote:
> Hi Philippe, Antoine,
> 
> On Wed, 2019-02-06 at 23:30 +0100, Philippe Mathieu-Daudé wrote:
>> Hi Antoine,
>>
>> On 2/6/19 6:24 PM, Antoine Coeur wrote:
>>> Fix various typos in CryptoPkg.
>>>
>>> Contributed-under: TianoCore Contribution Agreement 1.1
>>> Signed-off-by: Coeur <coeur@gmx.fr>
>>> ---
>>>  CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c         | 2 +-
>>>  CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c | 4 ++--
>>>  2 files changed, 3 insertions(+), 3 deletions(-)
>>>
>>> diff --git a/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
>>> b/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
>>> index d63c23df09..540c5715cb 100644
>>> --- a/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
>>> +++ b/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
>>> @@ -142,7 +142,7 @@ IMPLEMENT_ASN1_FUNCTIONS (TS_TST_INFO)
>>>    @param[in]  Asn1Time         Pointer to the ASN.1
>>> GeneralizedTime to be converted.
>>>    @param[out] SigningTime      Return the corresponding EFI Time.
>>>  
>>> -  @retval  TRUE   The time convertion succeeds.
>>> +  @retval  TRUE   The time conversion succeeds.
>>
>> The typos are indeed fixed, so:
>> Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
>>
>> However reading this description makes me suspicious, I'd have
>> written
>> "The time convertion succeeded.", but I'm not native English speaker
>> so
>> I'll let someone with more insurance opinate.
> 
> I'm not a native speaker either, but I'd write "conversion" as well.
> (Like revert -> reversion, subvert -> subversion, avert -> aversion,
> and so on.)

Oops, I copy/pasted the wrong line :S
Indeed the correct word is "conversion", thanks for correcting me.

My wonder is about what is the correct use between succeeds/succeeded,
I'd expect the following diff:

-  @retval  TRUE   The time convertion succeeds.
+  @retval  TRUE   The time conversion succeeded.

>>
>> Regards,
>>
>> Phil.
>>
>>>    @retval  FALSE  Invalid parameters.
>>>  
>>>  **/
>>> diff --git a/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
>>> b/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
>>> index 9510a4a383..929e3fcd1e 100644
>>> --- a/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
>>> +++ b/CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c
>>> @@ -84,14 +84,14 @@ QuickSortWorker (
>>>      }
>>>    }
>>>    //
>>> -  // Swap pivot to it's final position (NextSwapLocaiton)
>>> +  // Swap pivot to it's final position (NextSwapLocation)
>>>    //
>>>    CopyMem (Buffer, Pivot, ElementSize);
>>>    CopyMem (Pivot, (UINT8 *)BufferToSort + (NextSwapLocation *
>>> ElementSize), ElementSize);
>>>    CopyMem ((UINT8 *)BufferToSort + (NextSwapLocation *
>>> ElementSize), Buffer, ElementSize);
>>>  
>>>    //
>>> -  // Now recurse on 2 paritial lists.  Neither of these will have
>>> the 'pivot' element.
>>> +  // Now recurse on 2 partial lists.  Neither of these will have
>>> the 'pivot' element.
>>>    // IE list is sorted left half, pivot element, sorted right
>>> half...
>>>    //
>>>    QuickSortWorker (
>>>
>> _______________________________________________
>> edk2-devel mailing list
>> edk2-devel@lists.01.org
>> https://lists.01.org/mailman/listinfo/edk2-devel
> 

Re: [PATCH] CryptoPkg: Fix various typos

[Antoine Coeur]

> My wonder is about what is the correct use between succeeds/succeeded,
> I'd expect the following diff:
> 
> - @retval TRUE The time convertion succeeds.
> + @retval TRUE The time conversion succeeded.

In doubt, I'll just ignore this one. I made a v2 to address Jian review.
Thank you for reviewing this package.

Coeur

Re: [PATCH] CryptoPkg: Fix various typos

[Laszlo Ersek]

On 02/07/19 15:59, Philippe Mathieu-Daudé wrote:
> On 2/7/19 2:04 PM, Ryszard Knop wrote:
>> Hi Philippe, Antoine,
>>
>> On Wed, 2019-02-06 at 23:30 +0100, Philippe Mathieu-Daudé wrote:
>>> Hi Antoine,
>>>
>>> On 2/6/19 6:24 PM, Antoine Coeur wrote:
>>>> Fix various typos in CryptoPkg.
>>>>
>>>> Contributed-under: TianoCore Contribution Agreement 1.1
>>>> Signed-off-by: Coeur <coeur@gmx.fr>
>>>> ---
>>>>  CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c         | 2 +-
>>>>  CryptoPkg/Library/BaseCryptLib/SysCall/CrtWrapper.c | 4 ++--
>>>>  2 files changed, 3 insertions(+), 3 deletions(-)
>>>>
>>>> diff --git a/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
>>>> b/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
>>>> index d63c23df09..540c5715cb 100644
>>>> --- a/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
>>>> +++ b/CryptoPkg/Library/BaseCryptLib/Pk/CryptTs.c
>>>> @@ -142,7 +142,7 @@ IMPLEMENT_ASN1_FUNCTIONS (TS_TST_INFO)
>>>>    @param[in]  Asn1Time         Pointer to the ASN.1
>>>> GeneralizedTime to be converted.
>>>>    @param[out] SigningTime      Return the corresponding EFI Time.
>>>>  
>>>> -  @retval  TRUE   The time convertion succeeds.
>>>> +  @retval  TRUE   The time conversion succeeds.
>>>
>>> The typos are indeed fixed, so:
>>> Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
>>>
>>> However reading this description makes me suspicious, I'd have
>>> written
>>> "The time convertion succeeded.", but I'm not native English speaker
>>> so
>>> I'll let someone with more insurance opinate.
>>
>> I'm not a native speaker either, but I'd write "conversion" as well.
>> (Like revert -> reversion, subvert -> subversion, avert -> aversion,
>> and so on.)
> 
> Oops, I copy/pasted the wrong line :S
> Indeed the correct word is "conversion", thanks for correcting me.
> 
> My wonder is about what is the correct use between succeeds/succeeded,
> I'd expect the following diff:
> 
> -  @retval  TRUE   The time convertion succeeds.
> +  @retval  TRUE   The time conversion succeeded.

Personally I'm fine either way, succeeds/succeeded.

... While the latter does look a bit improved, this patch is about typo
fixes, not grammar fixes, so I guess we should stick with just
conver[ts]ion for now.

Just my 2 cents.

Thanks
Laszlo