[PATCH net] net: sock: remove excess structure-member documentation

[PATCH net] net: sock: remove excess structure-member documentation

[Jonathan Corbet]

Remove a couple of kerneldoc entries for struct members that do not exist,
addressing these warnings:

  ./include/net/sock.h:548: warning: Excess struct member '__sk_flags_offset' description in 'sock'
  ./include/net/sock.h:548: warning: Excess struct member 'sk_padding' description in 'sock'

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 include/net/sock.h | 2 --
 1 file changed, 2 deletions(-)

diff --git a/include/net/sock.h b/include/net/sock.h
index 1d6931caf0c3..bee854b477b2 100644
--- a/include/net/sock.h
+++ b/include/net/sock.h
@@ -277,8 +277,6 @@ struct sk_filter;
   *	@sk_pacing_status: Pacing status (requested, handled by sch_fq)
   *	@sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
   *	@sk_sndbuf: size of send buffer in bytes
-  *	@__sk_flags_offset: empty field used to determine location of bitfield
-  *	@sk_padding: unused element for alignment
   *	@sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
   *	@sk_no_check_rx: allow zero checksum in RX packets
   *	@sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
-- 
2.43.0

Re: [PATCH net] net: sock: remove excess structure-member documentation

[Randy Dunlap]

On 12/19/23 15:51, Jonathan Corbet wrote:
> Remove a couple of kerneldoc entries for struct members that do not exist,
> addressing these warnings:
> 
>   ./include/net/sock.h:548: warning: Excess struct member '__sk_flags_offset' description in 'sock'
>   ./include/net/sock.h:548: warning: Excess struct member 'sk_padding' description in 'sock'
> 
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  include/net/sock.h | 2 --
>  1 file changed, 2 deletions(-)
> 
> diff --git a/include/net/sock.h b/include/net/sock.h
> index 1d6931caf0c3..bee854b477b2 100644
> --- a/include/net/sock.h
> +++ b/include/net/sock.h
> @@ -277,8 +277,6 @@ struct sk_filter;
>    *	@sk_pacing_status: Pacing status (requested, handled by sch_fq)
>    *	@sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
>    *	@sk_sndbuf: size of send buffer in bytes
> -  *	@__sk_flags_offset: empty field used to determine location of bitfield
> -  *	@sk_padding: unused element for alignment
>    *	@sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
>    *	@sk_no_check_rx: allow zero checksum in RX packets
>    *	@sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html

Re: [PATCH net] net: sock: remove excess structure-member documentation

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by David S. Miller <davem@davemloft.net>:

On Tue, 19 Dec 2023 16:51:12 -0700 you wrote:
> Remove a couple of kerneldoc entries for struct members that do not exist,
> addressing these warnings:
> 
>   ./include/net/sock.h:548: warning: Excess struct member '__sk_flags_offset' description in 'sock'
>   ./include/net/sock.h:548: warning: Excess struct member 'sk_padding' description in 'sock'
> 
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> 
> [...]

Here is the summary with links:
  - [net] net: sock: remove excess structure-member documentation
    https://git.kernel.org/netdev/net-next/c/144377c340f2

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html