net: openvswitch: fix kernel-doc warnings in flow.c
Subsystems (3)
PATCH 1/1 net: openvswitch: fix kernel-doc warnings in flow.c
Repair kernel-doc notation in a few places to make it conform to the expected format.
Fixes the following kernel-doc warnings:
flow.c:296: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Parse vlan tag from vlan header.
flow.c:296: warning: missing initial short description on line:
* Parse vlan tag from vlan header.
flow.c:537: warning: No description found for return value of 'key_extract_l3l4'
flow.c:769: warning: No description found for return value of 'key_extract'
--- net/openvswitch/flow.c | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-)
net/openvswitch/flow.c +7 -6
@@ -293,14 +293,14 @@ static bool icmp6hdr_ok(struct sk_buff * }/** -* Parse vlan tag from vlan header. +* parse_vlan_tag - Parse vlan tag from vlan header. * @skb: skb containing frame to parse * @key_vh: pointer to parsed vlan tag * @untag_vlan: should the vlan header be removed from the frame * -* Returns ERROR on memory error. -* Returns 0 if it encounters a non-vlan or incomplete packet. -* Returns 1 after successfully parsing vlan tag. +* Return: ERROR on memory error. +* %0 if it encounters a non-vlan or incomplete packet. +* %1 after successfully parsing vlan tag. */ static int parse_vlan_tag (struct sk_buff *skb,struct vlan_head *key_vh,bool untag_vlan)
@@ -532,6 +532,7 @@ static int parse_nsh(struct sk_buff *skb* L3 header * @key: output flow key * +* Return: %0 if successful, otherwise a negative errno value. */ static int key_extract_l3l4 (struct sk_buff *skb,struct sw_flow_key *key) {
@@ -748,8 +749,6 @@ static int key_extract_l3l4(struct sk_bu* * The caller must ensure that skb->len >= ETH_HLEN. * -* Returns 0 if successful, otherwise a negative errno value. -* * Initializes @skb header fields as follows: * * - skb->mac_header: the L2 header.
@@ -764,6 +763,8 @@ static int key_extract_l3l4(struct sk_bu* * - skb->protocol: the type of the data starting at skb->network_header. * Equals to key->eth.type. +* +* Return: %0 if successful, otherwise a negative errno value. */ static int key_extract (struct sk_buff *skb,struct sw_flow_key *key) {
This patch was applied to netdev/net.git (refs/heads/master):
Hello:
This patch was applied to netdev/net.git (refs/heads/master):
Quoted 5 lines · On Sun, 8 Aug 2021 12:08:34 -0700 you wrote:
Repair kernel-doc notation in a few places to make it conform to the expected format.
Fixes the following kernel-doc warnings:
Quoted 8 lines
flow.c:296: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer
Documentation/doc-guide/kernel-doc.rst
* Parse vlan tag from vlan header.
flow.c:296: warning: missing initial short description on line:
* Parse vlan tag from vlan header.
flow.c:537: warning: No description found for return value of 'key_extract_l3l4'
flow.c:769: warning: No description found for return value of 'key_extract'[...]
Here is the summary with links:
- net: openvswitch: fix kernel-doc warnings in flow.c
https://git.kernel.org/netdev/net/c/d6e712aa7e6a
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html