[PATCH] net: liquidio: fix typo

[PATCH] net: liquidio: fix typo

[Janik Haag]

Dear Linux maintainers, this is my first patch, hope everything is
correct.

While reading through some pcie realted code I notice this small
spelling mistake of doorbell registers.
I added Dave in the TO field since they signed-off on by far the most
commits touching this file.

With kind regards,
Janik Haag

Signed-off-by: Janik Haag <janik@aq0.de>
---
 drivers/net/ethernet/cavium/liquidio/cn23xx_pf_device.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/net/ethernet/cavium/liquidio/cn23xx_pf_device.c b/drivers/net/ethernet/cavium/liquidio/cn23xx_pf_device.c
index 9ad49aea2673..5f3d39e2ceca 100644
--- a/drivers/net/ethernet/cavium/liquidio/cn23xx_pf_device.c
+++ b/drivers/net/ethernet/cavium/liquidio/cn23xx_pf_device.c
@@ -373,7 +373,7 @@ static void cn23xx_pf_setup_global_output_regs(struct octeon_device *oct)
 	/** Setting the water mark level for pko back pressure **/
 	writeq(0x40, (u8 *)oct->mmio[0].hw_addr + CN23XX_SLI_OQ_WMARK);
 
-	/** Disabling setting OQs in reset when ring has no dorebells
+	/** Disabling setting OQs in reset when ring has no doorbells
 	 * enabling this will cause of head of line blocking
 	 */
 	/* Do it only for pass1.1. and pass1.2 */

base-commit: 99fa936e8e4f117d62f229003c9799686f74cebc
-- 
2.48.1

Re: [PATCH] net: liquidio: fix typo

[Simon Horman]

On Tue, Mar 04, 2025 at 07:16:52PM +0100, Janik Haag wrote:
> Dear Linux maintainers, this is my first patch, hope everything is
> correct.
> 
> While reading through some pcie realted code I notice this small
> spelling mistake of doorbell registers.
> I added Dave in the TO field since they signed-off on by far the most
> commits touching this file.
> 
> With kind regards,
> Janik Haag
> 
> Signed-off-by: Janik Haag <janik@aq0.de>
> ---
>  drivers/net/ethernet/cavium/liquidio/cn23xx_pf_device.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Hi Jainik,

Thanks for your patch.
It looks good, but I think we can make it better.


Firstly, it's normal practice to describe your patch in the patch
description, which is the bit above the scissors ("---") and add any notes
below. Something like this.

  Subject: net: liquidio: fix typo

  Correct spelling of doorbells.

  Found by inspection

  Signed-of-by: ...
  ---

  Dear Linux Maintainers,

  ...

Secondly, as this is a non-bug-fix for Networking code it is for the
net-next tree. It is preferable to note that net-next is the target
tree in the subject, like this:

  Subject: [PATCH net-next] net: liquidio: fix typo

Last, I do see that codespell flags some other spelling errors in
this file: "corressponding", "cant", and "Fomat".
Perhaps they can be fixed at the same time?


Could you consider posting a v2 patch, as a new thread, which
addresses the above? The subject should be something like this:

  Subject: [PATCH net-next v2] net: liquidio: fix typo

As an aside, the b4 tool can be helpful for managing patch revisions.

More information on Netdev process can be found here;
https://docs.kernel.org/process/maintainer-netdev.html

...

-- 
pw-bot: changes-requested

Re: [PATCH] net: liquidio: fix typo

[Janik Haag]

Dear Simon,

I just submitted a v2 version of the patch, like you asked me to.
Thanks for the kind review and enjoy your weekend!

With kind regards,
Janik Haag

On 06.03.25 13:22, Simon Horman wrote:
> On Tue, Mar 04, 2025 at 07:16:52PM +0100, Janik Haag wrote:
>> Dear Linux maintainers, this is my first patch, hope everything is
>> correct.
>>
>> While reading through some pcie realted code I notice this small
>> spelling mistake of doorbell registers.
>> I added Dave in the TO field since they signed-off on by far the most
>> commits touching this file.
>>
>> With kind regards,
>> Janik Haag
>>
>> Signed-off-by: Janik Haag <janik@aq0.de>
>> ---
>>   drivers/net/ethernet/cavium/liquidio/cn23xx_pf_device.c | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
> Hi Jainik,
>
> Thanks for your patch.
> It looks good, but I think we can make it better.
>
>
> Firstly, it's normal practice to describe your patch in the patch
> description, which is the bit above the scissors ("---") and add any notes
> below. Something like this.
>
>    Subject: net: liquidio: fix typo
>
>    Correct spelling of doorbells.
>
>    Found by inspection
>
>    Signed-of-by: ...
>    ---
>
>    Dear Linux Maintainers,
>
>    ...
>
> Secondly, as this is a non-bug-fix for Networking code it is for the
> net-next tree. It is preferable to note that net-next is the target
> tree in the subject, like this:
>
>    Subject: [PATCH net-next] net: liquidio: fix typo
>
> Last, I do see that codespell flags some other spelling errors in
> this file: "corressponding", "cant", and "Fomat".
> Perhaps they can be fixed at the same time?
>
>
> Could you consider posting a v2 patch, as a new thread, which
> addresses the above? The subject should be something like this:
>
>    Subject: [PATCH net-next v2] net: liquidio: fix typo
>
> As an aside, the b4 tool can be helpful for managing patch revisions.
>
> More information on Netdev process can be found here;
> https://docs.kernel.org/process/maintainer-netdev.html
>
> ...
>