Commit 53c3fa206415d8a3f8b2a4f77689ea044c4a9c65

Authored by Randy Dunlap
Committed by David S. Miller
1 parent 7ed24e8da7

net/sock.h: add missing kernel-doc notation

Add missing kernel-doc notation to struct sock:

Warning(include/net/sock.h:324): No description found for parameter 'sk_peer_pid'
Warning(include/net/sock.h:324): No description found for parameter 'sk_peer_cred'
Warning(include/net/sock.h:324): No description found for parameter 'sk_classid'
Warning(include/net/sock.h:324): Excess struct/union/enum/typedef member 'sk_peercred' description in 'sock'

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

Showing 1 changed file with 3 additions and 1 deletions Side-by-side Diff

... ... @@ -195,7 +195,8 @@
195 195 * @sk_priority: %SO_PRIORITY setting
196 196 * @sk_type: socket type (%SOCK_STREAM, etc)
197 197 * @sk_protocol: which protocol this socket belongs in this network family
198   - * @sk_peercred: %SO_PEERCRED setting
  198 + * @sk_peer_pid: &struct pid for this socket's peer
  199 + * @sk_peer_cred: %SO_PEERCRED setting
199 200 * @sk_rcvlowat: %SO_RCVLOWAT setting
200 201 * @sk_rcvtimeo: %SO_RCVTIMEO setting
201 202 * @sk_sndtimeo: %SO_SNDTIMEO setting
... ... @@ -211,6 +212,7 @@
211 212 * @sk_send_head: front of stuff to transmit
212 213 * @sk_security: used by security modules
213 214 * @sk_mark: generic packet mark
  215 + * @sk_classid: this socket's cgroup classid
214 216 * @sk_write_pending: a write to stream socket waits to start
215 217 * @sk_state_change: callback to indicate change in the state of the sock
216 218 * @sk_data_ready: callback to indicate there is data to be processed