diff mbox series

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

Message ID 874jgdhhu7.fsf@meer.lwn.net (mailing list archive)
State Accepted
Commit 144377c340f292c5d8c039eb790318754eec557e
Delegated to: Netdev Maintainers
Headers show
Series [net] net: sock: remove excess structure-member documentation | expand

Checks

Context Check Description
netdev/series_format success Single patches do not need cover letters
netdev/tree_selection success Clearly marked for net, async
netdev/ynl success SINGLE THREAD; Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present fail Series targets non-next tree, but doesn't contain any Fixes tags
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 3637 this patch: 3637
netdev/cc_maintainers success CCed 4 of 4 maintainers
netdev/build_clang success Errors and warnings before: 1288 this patch: 1288
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 3876 this patch: 3876
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 8 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Jonathan Corbet Dec. 19, 2023, 11:51 p.m. UTC
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(-)

Comments

Randy Dunlap Dec. 19, 2023, 11:55 p.m. UTC | #1
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)
patchwork-bot+netdevbpf@kernel.org Dec. 29, 2023, 1:30 a.m. UTC | #2
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!
diff mbox series

Patch

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)