mbox series

[net-next,00/13] net: header and core spelling corrections

Message ID 20240822-net-spell-v1-0-3a98971ce2d2@kernel.org (mailing list archive)
Headers show
Series net: header and core spelling corrections | expand

Message

Simon Horman Aug. 22, 2024, 12:57 p.m. UTC
This patchset addresses a number of spelling errors in comments in
Networking files under include/, and files in net/core/. Spelling
problems are as flagged by codespell.

It aims to provide patches that can be accepted directly into net-next.
And splits patches up based on maintainer boundaries: many things
feed directly into net-next. This is a complex process and I apologise
for any errors.

I also plan to address, via separate patches, spelling errors in other
files in the same directories, for files whose changes typically go
through trees other than net-next (which feed into net-next).

---
Simon Horman (13):
      packet: Correct spelling in if_packet.h
      s390/iucv: Correct spelling in iucv.h
      ip_tunnel: Correct spelling in ip_tunnels.h
      ipv6: Correct spelling in ipv6.h
      bonding: Correct spelling in headers
      net: qualcomm: rmnet: Correct spelling in if_rmnet.h
      netlabel: Correct spelling in netlabel.h
      NFC: Correct spelling in headers
      net: sched: Correct spelling in headers
      sctp: Correct spelling in headers
      x25: Correct spelling in x25.h
      net: Correct spelling in headers
      net: Correct spelling in net/core

 include/linux/etherdevice.h    |  2 +-
 include/linux/if_rmnet.h       |  2 +-
 include/linux/netdevice.h      |  8 ++++----
 include/net/addrconf.h         |  2 +-
 include/net/bond_3ad.h         |  5 ++++-
 include/net/bond_alb.h         |  2 +-
 include/net/busy_poll.h        |  2 +-
 include/net/caif/caif_layer.h  |  4 ++--
 include/net/caif/cfpkt.h       |  2 +-
 include/net/dropreason-core.h  |  6 +++---
 include/net/dst.h              |  2 +-
 include/net/dst_cache.h        |  2 +-
 include/net/erspan.h           |  4 ++--
 include/net/hwbm.h             |  4 ++--
 include/net/ip_tunnels.h       |  2 +-
 include/net/ipv6.h             |  4 ++--
 include/net/iucv/iucv.h        |  2 +-
 include/net/llc_pdu.h          |  2 +-
 include/net/netlabel.h         |  2 +-
 include/net/netlink.h          | 16 ++++++++--------
 include/net/netns/sctp.h       |  4 ++--
 include/net/nfc/nci.h          |  2 +-
 include/net/nfc/nfc.h          |  8 ++++----
 include/net/pkt_cls.h          |  2 +-
 include/net/red.h              |  8 ++++----
 include/net/regulatory.h       |  2 +-
 include/net/sctp/sctp.h        |  2 +-
 include/net/sctp/structs.h     | 20 ++++++++++----------
 include/net/sock.h             |  4 ++--
 include/net/udp.h              |  2 +-
 include/net/x25.h              |  2 +-
 include/uapi/linux/if_packet.h |  7 ++++---
 include/uapi/linux/in.h        |  2 +-
 include/uapi/linux/inet_diag.h |  2 +-
 net/core/dev.c                 |  6 +++---
 net/core/dev_addr_lists.c      |  6 +++---
 net/core/fib_rules.c           |  2 +-
 net/core/gro.c                 |  2 +-
 net/core/netpoll.c             |  2 +-
 net/core/pktgen.c              | 10 +++++-----
 net/core/skbuff.c              |  4 ++--
 net/core/sock.c                |  6 +++---
 net/core/utils.c               |  2 +-
 43 files changed, 93 insertions(+), 89 deletions(-)

base-commit: 001b98c9897352e914c71d8ffbfa9b79a6e12c3c

Comments

Philipp Stanner Aug. 25, 2024, 7:52 a.m. UTC | #1
Am Donnerstag, dem 22.08.2024 um 13:57 +0100 schrieb Simon Horman:
> This patchset addresses a number of spelling errors in comments in
> Networking files under include/, and files in net/core/. Spelling
> problems are as flagged by codespell.
> 
> It aims to provide patches that can be accepted directly into net-
> next.
> And splits patches up based on maintainer boundaries: many things
> feed directly into net-next. This is a complex process and I
> apologise
> for any errors.

Are you aware that this lessens git blame's ability to provide the
latest relevant change and associated commit message?

Many software projects suffer from whitespace and spelling fixes
preventing git blame from figuring out years later what original code
was intended to do.

I'd consider that improving spelling might not win that cost-benefit-
ratio.


Regards,
P.


> 
> I also plan to address, via separate patches, spelling errors in
> other
> files in the same directories, for files whose changes typically go
> through trees other than net-next (which feed into net-next).
> 
> ---
> Simon Horman (13):
>       packet: Correct spelling in if_packet.h
>       s390/iucv: Correct spelling in iucv.h
>       ip_tunnel: Correct spelling in ip_tunnels.h
>       ipv6: Correct spelling in ipv6.h
>       bonding: Correct spelling in headers
>       net: qualcomm: rmnet: Correct spelling in if_rmnet.h
>       netlabel: Correct spelling in netlabel.h
>       NFC: Correct spelling in headers
>       net: sched: Correct spelling in headers
>       sctp: Correct spelling in headers
>       x25: Correct spelling in x25.h
>       net: Correct spelling in headers
>       net: Correct spelling in net/core
> 
>  include/linux/etherdevice.h    |  2 +-
>  include/linux/if_rmnet.h       |  2 +-
>  include/linux/netdevice.h      |  8 ++++----
>  include/net/addrconf.h         |  2 +-
>  include/net/bond_3ad.h         |  5 ++++-
>  include/net/bond_alb.h         |  2 +-
>  include/net/busy_poll.h        |  2 +-
>  include/net/caif/caif_layer.h  |  4 ++--
>  include/net/caif/cfpkt.h       |  2 +-
>  include/net/dropreason-core.h  |  6 +++---
>  include/net/dst.h              |  2 +-
>  include/net/dst_cache.h        |  2 +-
>  include/net/erspan.h           |  4 ++--
>  include/net/hwbm.h             |  4 ++--
>  include/net/ip_tunnels.h       |  2 +-
>  include/net/ipv6.h             |  4 ++--
>  include/net/iucv/iucv.h        |  2 +-
>  include/net/llc_pdu.h          |  2 +-
>  include/net/netlabel.h         |  2 +-
>  include/net/netlink.h          | 16 ++++++++--------
>  include/net/netns/sctp.h       |  4 ++--
>  include/net/nfc/nci.h          |  2 +-
>  include/net/nfc/nfc.h          |  8 ++++----
>  include/net/pkt_cls.h          |  2 +-
>  include/net/red.h              |  8 ++++----
>  include/net/regulatory.h       |  2 +-
>  include/net/sctp/sctp.h        |  2 +-
>  include/net/sctp/structs.h     | 20 ++++++++++----------
>  include/net/sock.h             |  4 ++--
>  include/net/udp.h              |  2 +-
>  include/net/x25.h              |  2 +-
>  include/uapi/linux/if_packet.h |  7 ++++---
>  include/uapi/linux/in.h        |  2 +-
>  include/uapi/linux/inet_diag.h |  2 +-
>  net/core/dev.c                 |  6 +++---
>  net/core/dev_addr_lists.c      |  6 +++---
>  net/core/fib_rules.c           |  2 +-
>  net/core/gro.c                 |  2 +-
>  net/core/netpoll.c             |  2 +-
>  net/core/pktgen.c              | 10 +++++-----
>  net/core/skbuff.c              |  4 ++--
>  net/core/sock.c                |  6 +++---
>  net/core/utils.c               |  2 +-
>  43 files changed, 93 insertions(+), 89 deletions(-)
> 
> base-commit: 001b98c9897352e914c71d8ffbfa9b79a6e12c3c
> 
>
Krzysztof Kozlowski Aug. 25, 2024, 8:06 a.m. UTC | #2
On 25/08/2024 09:52, Philipp Stanner wrote:
> Am Donnerstag, dem 22.08.2024 um 13:57 +0100 schrieb Simon Horman:
>> This patchset addresses a number of spelling errors in comments in
>> Networking files under include/, and files in net/core/. Spelling
>> problems are as flagged by codespell.
>>
>> It aims to provide patches that can be accepted directly into net-
>> next.
>> And splits patches up based on maintainer boundaries: many things
>> feed directly into net-next. This is a complex process and I
>> apologise
>> for any errors.
> 
> Are you aware that this lessens git blame's ability to provide the
> latest relevant change and associated commit message?

Considering how many code style changes the kernel receives, I already
(and not only me) moved away to just `git log --follow`, so I don't find
one more step for `git blame` a problem.

> 
> Many software projects suffer from whitespace and spelling fixes
> preventing git blame from figuring out years later what original code
> was intended to do.
> 
> I'd consider that improving spelling might not win that cost-benefit-
> ratio.

I would rather claim that impact on backporting is more important, yet
still fixing style makes code more readable thus maintainable. And
that's a benefit.

Best regards,
Krzysztof
Simon Horman Aug. 25, 2024, 8:54 a.m. UTC | #3
On Sun, Aug 25, 2024 at 07:52:45AM +0000, Philipp Stanner wrote:
> Am Donnerstag, dem 22.08.2024 um 13:57 +0100 schrieb Simon Horman:
> > This patchset addresses a number of spelling errors in comments in
> > Networking files under include/, and files in net/core/. Spelling
> > problems are as flagged by codespell.
> > 
> > It aims to provide patches that can be accepted directly into net-
> > next.
> > And splits patches up based on maintainer boundaries: many things
> > feed directly into net-next. This is a complex process and I
> > apologise
> > for any errors.
> 
> Are you aware that this lessens git blame's ability to provide the
> latest relevant change and associated commit message?
> 
> Many software projects suffer from whitespace and spelling fixes
> preventing git blame from figuring out years later what original code
> was intended to do.
> 
> I'd consider that improving spelling might not win that cost-benefit-
> ratio.

Sure, that is a judgment call that can be made.  I think that it is pretty
common for spelling corrections to be accepted, and I do think there is a
value in having things spelt correctly.  But if the consensus is otherwise,
then fine.
patchwork-bot+netdevbpf@kernel.org Aug. 26, 2024, 4:50 p.m. UTC | #4
Hello:

This series was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Thu, 22 Aug 2024 13:57:21 +0100 you wrote:
> This patchset addresses a number of spelling errors in comments in
> Networking files under include/, and files in net/core/. Spelling
> problems are as flagged by codespell.
> 
> It aims to provide patches that can be accepted directly into net-next.
> And splits patches up based on maintainer boundaries: many things
> feed directly into net-next. This is a complex process and I apologise
> for any errors.
> 
> [...]

Here is the summary with links:
  - [net-next,01/13] packet: Correct spelling in if_packet.h
    https://git.kernel.org/netdev/net-next/c/d24dac8eb811
  - [net-next,02/13] s390/iucv: Correct spelling in iucv.h
    https://git.kernel.org/netdev/net-next/c/c34944603248
  - [net-next,03/13] ip_tunnel: Correct spelling in ip_tunnels.h
    https://git.kernel.org/netdev/net-next/c/d0193b167f27
  - [net-next,04/13] ipv6: Correct spelling in ipv6.h
    https://git.kernel.org/netdev/net-next/c/507285b7f9b2
  - [net-next,05/13] bonding: Correct spelling in headers
    https://git.kernel.org/netdev/net-next/c/e8ac2dba93ea
  - [net-next,06/13] net: qualcomm: rmnet: Correct spelling in if_rmnet.h
    https://git.kernel.org/netdev/net-next/c/19f1f11c9a8e
  - [net-next,07/13] netlabel: Correct spelling in netlabel.h
    https://git.kernel.org/netdev/net-next/c/6899c2549cf7
  - [net-next,08/13] NFC: Correct spelling in headers
    https://git.kernel.org/netdev/net-next/c/10d0749a38c3
  - [net-next,09/13] net: sched: Correct spelling in headers
    https://git.kernel.org/netdev/net-next/c/a7a45f02a093
  - [net-next,10/13] sctp: Correct spelling in headers
    https://git.kernel.org/netdev/net-next/c/7f47fcea8c6b
  - [net-next,11/13] x25: Correct spelling in x25.h
    https://git.kernel.org/netdev/net-next/c/01d86846a5a5
  - [net-next,12/13] net: Correct spelling in headers
    https://git.kernel.org/netdev/net-next/c/70d0bb45fae8
  - [net-next,13/13] net: Correct spelling in net/core
    https://git.kernel.org/netdev/net-next/c/a8c924e98738

You are awesome, thank you!