[PATCH] arch: powerpc: kernel: fixed some typos

[PATCH] arch: powerpc: kernel: fixed some typos

[Ghanshyam Agrawal]

Fixed some typos

Signed-off-by: Ghanshyam Agrawal <ghanshyam1898@gmail.com>
---
 arch/powerpc/kernel/eeh_pe.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/arch/powerpc/kernel/eeh_pe.c b/arch/powerpc/kernel/eeh_pe.c
index e0ce81279624..8e0c1a8b8641 100644
--- a/arch/powerpc/kernel/eeh_pe.c
+++ b/arch/powerpc/kernel/eeh_pe.c
@@ -24,10 +24,10 @@ static int eeh_pe_aux_size = 0;
 static LIST_HEAD(eeh_phb_pe);
 
 /**
- * eeh_set_pe_aux_size - Set PE auxillary data size
- * @size: PE auxillary data size
+ * eeh_set_pe_aux_size - Set PE auxiliary data size
+ * @size: PE auxiliary data size
  *
- * Set PE auxillary data size
+ * Set PE auxiliary data size
  */
 void eeh_set_pe_aux_size(int size)
 {
-- 
2.25.1

Re: [PATCH] arch: powerpc: kernel: fixed some typos

[Christophe Leroy]

Le 15/12/2023 à 12:58, Ghanshyam Agrawal a écrit :
> [Vous ne recevez pas souvent de courriers de ghanshyam1898@gmail.com. Découvrez pourquoi ceci est important à https://aka.ms/LearnAboutSenderIdentification ]
> 
> Fixed some typos

This kind of change is a waist of time for us and a waist of time for you.

Please fix those type when you do real changes to the file, otherwise 
the changes are pointless, everyone is able to understand the comments 
even with the typo.

Christophe

> 
> Signed-off-by: Ghanshyam Agrawal <ghanshyam1898@gmail.com>
> ---
>   arch/powerpc/kernel/eeh_pe.c | 6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/arch/powerpc/kernel/eeh_pe.c b/arch/powerpc/kernel/eeh_pe.c
> index e0ce81279624..8e0c1a8b8641 100644
> --- a/arch/powerpc/kernel/eeh_pe.c
> +++ b/arch/powerpc/kernel/eeh_pe.c
> @@ -24,10 +24,10 @@ static int eeh_pe_aux_size = 0;
>   static LIST_HEAD(eeh_phb_pe);
> 
>   /**
> - * eeh_set_pe_aux_size - Set PE auxillary data size
> - * @size: PE auxillary data size
> + * eeh_set_pe_aux_size - Set PE auxiliary data size
> + * @size: PE auxiliary data size
>    *
> - * Set PE auxillary data size
> + * Set PE auxiliary data size
>    */
>   void eeh_set_pe_aux_size(int size)
>   {
> --
> 2.25.1
> 

Re: [PATCH] arch: powerpc: kernel: fixed some typos

[Michael Ellerman]

Ghanshyam Agrawal <ghanshyam1898@gmail.com> writes:
> Fixed some typos
>
> Signed-off-by: Ghanshyam Agrawal <ghanshyam1898@gmail.com>
> ---
>  arch/powerpc/kernel/eeh_pe.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)

Please also fix the case in arch/powerpc/include/asm/eeh.h

The subject should use the correct prefix. You can see what it should be
using:

$ git log --oneline arch/powerpc/kernel/eeh_pe.c

Please give the patch a better subject, not "some typos", tell me what
misspelling you're fixing. Same comment for the commit description.

> diff --git a/arch/powerpc/kernel/eeh_pe.c b/arch/powerpc/kernel/eeh_pe.c
> index e0ce81279624..8e0c1a8b8641 100644
> --- a/arch/powerpc/kernel/eeh_pe.c
> +++ b/arch/powerpc/kernel/eeh_pe.c
> @@ -24,10 +24,10 @@ static int eeh_pe_aux_size = 0;
>  static LIST_HEAD(eeh_phb_pe);
>  
>  /**
> - * eeh_set_pe_aux_size - Set PE auxillary data size
> - * @size: PE auxillary data size
> + * eeh_set_pe_aux_size - Set PE auxiliary data size
> + * @size: PE auxiliary data size
 
While you're changing it you could also mention what the units of the
size are.

>   *
> - * Set PE auxillary data size
> + * Set PE auxiliary data size
 
This should gain a full stop at the end of the sentence.

>   */
>  void eeh_set_pe_aux_size(int size)
>  {
> -- 
> 2.25.1


cheers

Re: [PATCH] arch: powerpc: kernel: fixed some typos

[Ghanshyam Agrawal]

On Thu, Dec 21, 2023 at 4:55 PM Michael Ellerman <mpe@ellerman.id.au> wrote:
>
> Ghanshyam Agrawal <ghanshyam1898@gmail.com> writes:
> > Fixed some typos
> >
> > Signed-off-by: Ghanshyam Agrawal <ghanshyam1898@gmail.com>
> > ---
> >  arch/powerpc/kernel/eeh_pe.c | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
>
> Please also fix the case in arch/powerpc/include/asm/eeh.h
>
> The subject should use the correct prefix. You can see what it should be
> using:
>
> $ git log --oneline arch/powerpc/kernel/eeh_pe.c
>
> Please give the patch a better subject, not "some typos", tell me what
> misspelling you're fixing. Same comment for the commit description.
>
> > diff --git a/arch/powerpc/kernel/eeh_pe.c b/arch/powerpc/kernel/eeh_pe.c
> > index e0ce81279624..8e0c1a8b8641 100644
> > --- a/arch/powerpc/kernel/eeh_pe.c
> > +++ b/arch/powerpc/kernel/eeh_pe.c
> > @@ -24,10 +24,10 @@ static int eeh_pe_aux_size = 0;
> >  static LIST_HEAD(eeh_phb_pe);
> >
> >  /**
> > - * eeh_set_pe_aux_size - Set PE auxillary data size
> > - * @size: PE auxillary data size
> > + * eeh_set_pe_aux_size - Set PE auxiliary data size
> > + * @size: PE auxiliary data size
>
> While you're changing it you could also mention what the units of the
> size are.
>
> >   *
> > - * Set PE auxillary data size
> > + * Set PE auxiliary data size
>
> This should gain a full stop at the end of the sentence.
>
> >   */
> >  void eeh_set_pe_aux_size(int size)
> >  {
> > --
> > 2.25.1
>
>
> cheers

Hi Michael,

Thank you very much for your suggestions. I will implement them
and send a v2 patch.

You mentioned I need to specify the units of "PE auxiliary data size".
Is the unit BYTES? Sorry for the silly question, I am only beginning
to contribute to the linux kernel.

Thanks & Regards,
Ghanshyam Agrawal

Re: [PATCH] arch: powerpc: kernel: fixed some typos

[Michael Ellerman]

Ghanshyam Agrawal <ghanshyam1898@gmail.com> writes:
> On Thu, Dec 21, 2023 at 4:55 PM Michael Ellerman <mpe@ellerman.id.au> wrote:
>>
>> Ghanshyam Agrawal <ghanshyam1898@gmail.com> writes:
>> > Fixed some typos
>> >
>> > Signed-off-by: Ghanshyam Agrawal <ghanshyam1898@gmail.com>
>> > ---
>> >  arch/powerpc/kernel/eeh_pe.c | 6 +++---
>> >  1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> Please also fix the case in arch/powerpc/include/asm/eeh.h
>>
>> The subject should use the correct prefix. You can see what it should be
>> using:
>>
>> $ git log --oneline arch/powerpc/kernel/eeh_pe.c
>>
>> Please give the patch a better subject, not "some typos", tell me what
>> misspelling you're fixing. Same comment for the commit description.
>>
>> > diff --git a/arch/powerpc/kernel/eeh_pe.c b/arch/powerpc/kernel/eeh_pe.c
>> > index e0ce81279624..8e0c1a8b8641 100644
>> > --- a/arch/powerpc/kernel/eeh_pe.c
>> > +++ b/arch/powerpc/kernel/eeh_pe.c
>> > @@ -24,10 +24,10 @@ static int eeh_pe_aux_size = 0;
>> >  static LIST_HEAD(eeh_phb_pe);
>> >
>> >  /**
>> > - * eeh_set_pe_aux_size - Set PE auxillary data size
>> > - * @size: PE auxillary data size
>> > + * eeh_set_pe_aux_size - Set PE auxiliary data size
>> > + * @size: PE auxiliary data size
>>
>> While you're changing it you could also mention what the units of the
>> size are.
>>
>> >   *
>> > - * Set PE auxillary data size
>> > + * Set PE auxiliary data size
>>
>> This should gain a full stop at the end of the sentence.
>>
>> >   */
>> >  void eeh_set_pe_aux_size(int size)
>> >  {
>> > --
>> > 2.25.1
>
> Hi Michael,
>
> Thank you very much for your suggestions. I will implement them
> and send a v2 patch.
>
> You mentioned I need to specify the units of "PE auxiliary data size".
> Is the unit BYTES? Sorry for the silly question, I am only beginning
> to contribute to the linux kernel.

That's OK. Yes it's bytes.

If you look for where eeh_pe_aux_size is used, it's added to some other
values and then eventually passed to kzalloc(), which takes a size in
bytes. So you can infer that it is also in units of bytes.

cheers