[2/7] net: xen-netback: xenbus: Demote nonconformant kernel-doc headers

Commit Message

Lee Jones Jan. 15, 2021, 8:09 p.m. UTC

Fixes the following W=1 kernel build warning(s):

 drivers/net/xen-netback/xenbus.c:419: warning: Function parameter or member 'dev' not described in 'frontend_changed'
 drivers/net/xen-netback/xenbus.c:419: warning: Function parameter or member 'frontend_state' not described in 'frontend_changed'
 drivers/net/xen-netback/xenbus.c:1001: warning: Function parameter or member 'dev' not described in 'netback_probe'
 drivers/net/xen-netback/xenbus.c:1001: warning: Function parameter or member 'id' not described in 'netback_probe'

Cc: Wei Liu <[e-mail]>
Cc: Paul Durrant <[e-mail]>
Cc: "David S. Miller" <[e-mail]>
Cc: Jakub Kicinski <[e-mail]>
Cc: Alexei Starovoitov <[e-mail]>
Cc: Daniel Borkmann <[e-mail]>
Cc: Jesper Dangaard Brouer <[e-mail]>
Cc: John Fastabend <[e-mail]>
Cc: Rusty Russell <[e-mail]>
Cc: [e-mail]
Cc: [e-mail]
Cc: [e-mail]
Reviewed-by: Andrew Lunn <[e-mail]>
Signed-off-by: Lee Jones <[e-mail]>
---
 drivers/net/xen-netback/xenbus.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Paul Durrant Jan. 18, 2021, 10:35 a.m. UTC | #1

> -----Original Message-----
> From: Lee Jones <[e-mail]>
> Sent: 15 January 2021 20:09
> To: [e-mail]
> Cc: [e-mail]; Wei Liu <[e-mail]>; Paul Durrant <[e-mail]>; David S.
> Miller <[e-mail]>; Jakub Kicinski <[e-mail]>; Alexei Starovoitov <[e-mail]>;
> Daniel Borkmann <[e-mail]>; Jesper Dangaard Brouer <[e-mail]>; John Fastabend
> <[e-mail]>; Rusty Russell <[e-mail]>; [e-mail];
> [e-mail]; [e-mail]; Andrew Lunn <[e-mail]>
> Subject: [PATCH 2/7] net: xen-netback: xenbus: Demote nonconformant kernel-doc headers
> 
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/net/xen-netback/xenbus.c:419: warning: Function parameter or member 'dev' not described in
> 'frontend_changed'
>  drivers/net/xen-netback/xenbus.c:419: warning: Function parameter or member 'frontend_state' not
> described in 'frontend_changed'
>  drivers/net/xen-netback/xenbus.c:1001: warning: Function parameter or member 'dev' not described in
> 'netback_probe'
>  drivers/net/xen-netback/xenbus.c:1001: warning: Function parameter or member 'id' not described in
> 'netback_probe'
> 
> Cc: Wei Liu <[e-mail]>
> Cc: Paul Durrant <[e-mail]>
> Cc: "David S. Miller" <[e-mail]>
> Cc: Jakub Kicinski <[e-mail]>
> Cc: Alexei Starovoitov <[e-mail]>
> Cc: Daniel Borkmann <[e-mail]>
> Cc: Jesper Dangaard Brouer <[e-mail]>
> Cc: John Fastabend <[e-mail]>
> Cc: Rusty Russell <[e-mail]>
> Cc: [e-mail]
> Cc: [e-mail]
> Cc: [e-mail]
> Reviewed-by: Andrew Lunn <[e-mail]>
> Signed-off-by: Lee Jones <[e-mail]>

Reviewed-by: Paul Durrant <[e-mail]>

Patch

diff --git a/drivers/net/xen-netback/xenbus.c b/drivers/net/xen-netback/xenbus.c
index 6f10e0998f1ce..a5439c130130f 100644
--- a/drivers/net/xen-netback/xenbus.c
+++ b/drivers/net/xen-netback/xenbus.c
@@ -411,7 +411,7 @@  static void read_xenbus_frontend_xdp(struct backend_info *be,
 	vif->xdp_headroom = headroom;
 }
 
-/**
+/*
  * Callback received when the frontend's state changes.
  */
 static void frontend_changed(struct xenbus_device *dev,
@@ -996,7 +996,7 @@  static int netback_remove(struct xenbus_device *dev)
 	return 0;
 }
 
-/**
+/*
  * Entry point to this code when a new device is created.  Allocate the basic
  * structures and switch to InitWait.
  */