Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

mptcp: fix kdoc warnings

The following warnings were visible:

$ ./scripts/kernel-doc -Wall -none \
net/mptcp/ include/net/mptcp.h include/uapi/linux/mptcp*.h \
include/trace/events/mptcp.h
Warning: net/mptcp/token.c:108 No description found for return value of 'mptcp_token_new_request'
Warning: net/mptcp/token.c:151 No description found for return value of 'mptcp_token_new_connect'
Warning: net/mptcp/token.c:246 No description found for return value of 'mptcp_token_get_sock'
Warning: net/mptcp/token.c:298 No description found for return value of 'mptcp_token_iter_next'
Warning: net/mptcp/protocol.c:4431 No description found for return value of 'mptcp_splice_read'
Warning: include/uapi/linux/mptcp_pm.h:13 missing initial short description on line:
* enum mptcp_event_type

Address all of them: either by using the 'Return:' keyword, or by adding
a missing initial short description.

The MPTCP CI will soon report issues with kdoc to avoid introducing new
issues and being flagged by the Netdev CI.

Reviewed-by: Geliang Tang <geliang@kernel.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
Link: https://patch.msgid.link/20260205-net-mptcp-misc-fixes-6-19-rc8-v2-3-c2720ce75c34@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

authored by

Matthieu Baerts (NGI0) and committed by
Jakub Kicinski
136f1e16 364a7084

+11 -8
+1
Documentation/netlink/specs/mptcp_pm.yaml
··· 15 15 type: enum 16 16 name: event-type 17 17 enum-name: mptcp-event-type 18 + doc: Netlink MPTCP event types 18 19 name-prefix: mptcp-event- 19 20 entries: 20 21 -
+1 -1
include/uapi/linux/mptcp_pm.h
··· 11 11 #define MPTCP_PM_VER 1 12 12 13 13 /** 14 - * enum mptcp_event_type 14 + * enum mptcp_event_type - Netlink MPTCP event types 15 15 * @MPTCP_EVENT_UNSPEC: unused event 16 16 * @MPTCP_EVENT_CREATED: A new MPTCP connection has been created. It is the 17 17 * good time to allocate memory and send ADD_ADDR if needed. Depending on the
+9 -7
net/mptcp/token.c
··· 103 103 * It creates a unique token to identify the new mptcp connection, 104 104 * a secret local key and the initial data sequence number (idsn). 105 105 * 106 - * Returns 0 on success. 106 + * Return: 0 on success. 107 107 */ 108 108 int mptcp_token_new_request(struct request_sock *req) 109 109 { ··· 146 146 * the computed token at a later time, this is needed to process 147 147 * join requests. 148 148 * 149 - * returns 0 on success. 149 + * Return: 0 on success. 150 150 */ 151 151 int mptcp_token_new_connect(struct sock *ssk) 152 152 { ··· 241 241 * This function returns the mptcp connection structure with the given token. 242 242 * A reference count on the mptcp socket returned is taken. 243 243 * 244 - * returns NULL if no connection with the given token value exists. 244 + * Return: NULL if no connection with the given token value exists. 245 245 */ 246 246 struct mptcp_sock *mptcp_token_get_sock(struct net *net, u32 token) 247 247 { ··· 288 288 * @s_slot: start slot number 289 289 * @s_num: start number inside the given lock 290 290 * 291 - * This function returns the first mptcp connection structure found inside the 292 - * token container starting from the specified position, or NULL. 291 + * Description: 292 + * On successful iteration, the iterator is moved to the next position and a 293 + * reference to the returned socket is acquired. 293 294 * 294 - * On successful iteration, the iterator is moved to the next position and 295 - * a reference to the returned socket is acquired. 295 + * Return: 296 + * The first mptcp connection structure found inside the token container 297 + * starting from the specified position, or NULL. 296 298 */ 297 299 struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot, 298 300 long *s_num)