[PATCH] lib: zstd: clean up double word in comment.

[PATCH] lib: zstd: clean up double word in comment.

[trix]

From: Tom Rix <trix@redhat.com>

Remove the second 'a' and 'into'.

Signed-off-by: Tom Rix <trix@redhat.com>
---
 include/linux/zstd_lib.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/zstd_lib.h b/include/linux/zstd_lib.h
index b8c7dbf98390f..6b91758b61af9 100644
--- a/include/linux/zstd_lib.h
+++ b/include/linux/zstd_lib.h
@@ -1330,7 +1330,7 @@ ZSTDLIB_API size_t ZSTD_generateSequences(ZSTD_CCtx* zc, ZSTD_Sequence* outSeqs,
 
 /*! ZSTD_mergeBlockDelimiters() :
  * Given an array of ZSTD_Sequence, remove all sequences that represent block delimiters/last literals
- * by merging them into into the literals of the next sequence.
+ * by merging them into the literals of the next sequence.
  *
  * As such, the final generated result has no explicit representation of block boundaries,
  * and the final last literals segment is not represented in the sequences.
@@ -1377,7 +1377,7 @@ ZSTDLIB_API size_t ZSTD_compressSequences(ZSTD_CCtx* const cctx, void* dst, size
 /*! ZSTD_writeSkippableFrame() :
  * Generates a zstd skippable frame containing data given by src, and writes it to dst buffer.
  *
- * Skippable frames begin with a a 4-byte magic number. There are 16 possible choices of magic number,
+ * Skippable frames begin with a 4-byte magic number. There are 16 possible choices of magic number,
  * ranging from ZSTD_MAGIC_SKIPPABLE_START to ZSTD_MAGIC_SKIPPABLE_START+15.
  * As such, the parameter magicVariant controls the exact skippable frame magic number variant used, so
  * the magic number used will be ZSTD_MAGIC_SKIPPABLE_START + magicVariant.
-- 
2.26.3

Re: [PATCH] lib: zstd: clean up double word in comment.

[Nick Terrell]

> On Jan 20, 2022, at 5:20 AM, trix@redhat.com wrote:
> 
> From: Tom Rix <trix@redhat.com>
> 
> Remove the second 'a' and 'into'.

Thanks for the patch!

I'll merge this into my tree and get this into the 5.18 merge window.

If you are able to, can you please submit this patch as a PR upstream [0]?
Else, I will backport it before my next update. Either way I'll merge this patch.

Best,
Nick Terrell

[0] https://github.com/facebook/zstd/blob/dev/lib/zstd.h#L1396-L1407

> Signed-off-by: Tom Rix <trix@redhat.com>
> ---
> include/linux/zstd_lib.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/zstd_lib.h b/include/linux/zstd_lib.h
> index b8c7dbf98390f..6b91758b61af9 100644
> --- a/include/linux/zstd_lib.h
> +++ b/include/linux/zstd_lib.h
> @@ -1330,7 +1330,7 @@ ZSTDLIB_API size_t ZSTD_generateSequences(ZSTD_CCtx* zc, ZSTD_Sequence* outSeqs,
> 
> /*! ZSTD_mergeBlockDelimiters() :
>  * Given an array of ZSTD_Sequence, remove all sequences that represent block delimiters/last literals
> - * by merging them into into the literals of the next sequence.
> + * by merging them into the literals of the next sequence.
>  *
>  * As such, the final generated result has no explicit representation of block boundaries,
>  * and the final last literals segment is not represented in the sequences.
> @@ -1377,7 +1377,7 @@ ZSTDLIB_API size_t ZSTD_compressSequences(ZSTD_CCtx* const cctx, void* dst, size
> /*! ZSTD_writeSkippableFrame() :
>  * Generates a zstd skippable frame containing data given by src, and writes it to dst buffer.
>  *
> - * Skippable frames begin with a a 4-byte magic number. There are 16 possible choices of magic number,
> + * Skippable frames begin with a 4-byte magic number. There are 16 possible choices of magic number,
>  * ranging from ZSTD_MAGIC_SKIPPABLE_START to ZSTD_MAGIC_SKIPPABLE_START+15.
>  * As such, the parameter magicVariant controls the exact skippable frame magic number variant used, so
>  * the magic number used will be ZSTD_MAGIC_SKIPPABLE_START + magicVariant.
> -- 
> 2.26.3
> 

Re: [PATCH] lib: zstd: clean up double word in comment.

[Tom Rix]

On 1/24/22 12:18 PM, Nick Terrell wrote:
>
>> On Jan 20, 2022, at 5:20 AM, trix@redhat.com wrote:
>>
>> From: Tom Rix <trix@redhat.com>
>>
>> Remove the second 'a' and 'into'.
> Thanks for the patch!
>
> I'll merge this into my tree and get this into the 5.18 merge window.
>
> If you are able to, can you please submit this patch as a PR upstream [0]?
> Else, I will backport it before my next update. Either way I'll merge this patch.

yes, here it is

https://github.com/facebook/zstd/pull/3026

Tom

>
> Best,
> Nick Terrell
>
> [0] https://github.com/facebook/zstd/blob/dev/lib/zstd.h#L1396-L1407
>
>> Signed-off-by: Tom Rix <trix@redhat.com>
>> ---
>> include/linux/zstd_lib.h | 4 ++--
>> 1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/include/linux/zstd_lib.h b/include/linux/zstd_lib.h
>> index b8c7dbf98390f..6b91758b61af9 100644
>> --- a/include/linux/zstd_lib.h
>> +++ b/include/linux/zstd_lib.h
>> @@ -1330,7 +1330,7 @@ ZSTDLIB_API size_t ZSTD_generateSequences(ZSTD_CCtx* zc, ZSTD_Sequence* outSeqs,
>>
>> /*! ZSTD_mergeBlockDelimiters() :
>>   * Given an array of ZSTD_Sequence, remove all sequences that represent block delimiters/last literals
>> - * by merging them into into the literals of the next sequence.
>> + * by merging them into the literals of the next sequence.
>>   *
>>   * As such, the final generated result has no explicit representation of block boundaries,
>>   * and the final last literals segment is not represented in the sequences.
>> @@ -1377,7 +1377,7 @@ ZSTDLIB_API size_t ZSTD_compressSequences(ZSTD_CCtx* const cctx, void* dst, size
>> /*! ZSTD_writeSkippableFrame() :
>>   * Generates a zstd skippable frame containing data given by src, and writes it to dst buffer.
>>   *
>> - * Skippable frames begin with a a 4-byte magic number. There are 16 possible choices of magic number,
>> + * Skippable frames begin with a 4-byte magic number. There are 16 possible choices of magic number,
>>   * ranging from ZSTD_MAGIC_SKIPPABLE_START to ZSTD_MAGIC_SKIPPABLE_START+15.
>>   * As such, the parameter magicVariant controls the exact skippable frame magic number variant used, so
>>   * the magic number used will be ZSTD_MAGIC_SKIPPABLE_START + magicVariant.
>> -- 
>> 2.26.3
>>

Re: [PATCH] lib: zstd: clean up double word in comment.

[Nick Terrell]

> On Jan 20, 2022, at 5:20 AM, trix@redhat.com wrote:
> 
> From: Tom Rix <trix@redhat.com>
> 
> Remove the second 'a' and 'into'.
> 
> Signed-off-by: Tom Rix <trix@redhat.com>
> ---
> include/linux/zstd_lib.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/zstd_lib.h b/include/linux/zstd_lib.h
> index b8c7dbf98390f..6b91758b61af9 100644
> --- a/include/linux/zstd_lib.h
> +++ b/include/linux/zstd_lib.h
> @@ -1330,7 +1330,7 @@ ZSTDLIB_API size_t ZSTD_generateSequences(ZSTD_CCtx* zc, ZSTD_Sequence* outSeqs,
> 
> /*! ZSTD_mergeBlockDelimiters() :
>  * Given an array of ZSTD_Sequence, remove all sequences that represent block delimiters/last literals
> - * by merging them into into the literals of the next sequence.
> + * by merging them into the literals of the next sequence.
>  *
>  * As such, the final generated result has no explicit representation of block boundaries,
>  * and the final last literals segment is not represented in the sequences.
> @@ -1377,7 +1377,7 @@ ZSTDLIB_API size_t ZSTD_compressSequences(ZSTD_CCtx* const cctx, void* dst, size
> /*! ZSTD_writeSkippableFrame() :
>  * Generates a zstd skippable frame containing data given by src, and writes it to dst buffer.
>  *
> - * Skippable frames begin with a a 4-byte magic number. There are 16 possible choices of magic number,
> + * Skippable frames begin with a 4-byte magic number. There are 16 possible choices of magic number,
>  * ranging from ZSTD_MAGIC_SKIPPABLE_START to ZSTD_MAGIC_SKIPPABLE_START+15.
>  * As such, the parameter magicVariant controls the exact skippable frame magic number variant used, so
>  * the magic number used will be ZSTD_MAGIC_SKIPPABLE_START + magicVariant.
> -- 
> 2.26.3
> 

Thanks for the patch! I've merged it into my tree [0][1] and will be included in my next PR.

-Nick

[0] https://github.com/terrelln/linux/tree/zstd-linus
[1] https://github.com/terrelln/linux/commit/88a309465b3f05a100c3b81966982c0f9f5d23a6