diff mbox series

arch: powerpc: kernel: fixed some typos

Message ID 20231215115857.575697-1-ghanshyam1898@gmail.com (mailing list archive)
State Changes Requested
Headers show
Series arch: powerpc: kernel: fixed some typos | expand

Checks

Context Check Description
snowpatch_ozlabs/github-powerpc_ppctests success Successfully ran 8 jobs.
snowpatch_ozlabs/github-powerpc_selftests success Successfully ran 8 jobs.
snowpatch_ozlabs/github-powerpc_sparse success Successfully ran 4 jobs.
snowpatch_ozlabs/github-powerpc_clang success Successfully ran 6 jobs.
snowpatch_ozlabs/github-powerpc_kernel_qemu success Successfully ran 23 jobs.

Commit Message

Ghanshyam Agrawal Dec. 15, 2023, 11:58 a.m. UTC
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(-)

Comments

Michael Ellerman Dec. 21, 2023, 11:25 a.m. UTC | #1
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
Ghanshyam Agrawal Dec. 22, 2023, 6:19 a.m. UTC | #2
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
Michael Ellerman Dec. 27, 2023, 12:45 a.m. UTC | #3
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
diff mbox series

Patch

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)
 {