mirrors/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-10-02 07:04:24 +00:00
Code Issues Releases Wiki Activity

net: openvswitch: fix kernel-doc warnings in flow.c

Browse source 
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'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Pravin B Shelar <pshelar@ovn.org>
Cc: dev@openvswitch.org
Link: https://lore.kernel.org/r/20210808190834.23362-1-rdunlap@infradead.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
Randy Dunlap 2021-08-08 12:08:34 -07:00 committed by Jakub Kicinski
parent beb7f2de57
commit d6e712aa7e
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
net/openvswitch/flow.c
View file

@ -293,14 +293,14 @@ static bool icmp6hdr_ok(struct sk_buff *skb)
} }
/** /**
* Parse vlan tag from vlan header. * parse_vlan_tag - Parse vlan tag from vlan header.
* @skb: skb containing frame to parse * @skb: skb containing frame to parse
* @key_vh: pointer to parsed vlan tag * @key_vh: pointer to parsed vlan tag
* @untag_vlan: should the vlan header be removed from the frame * @untag_vlan: should the vlan header be removed from the frame
* *
* Returns ERROR on memory error. * Return: ERROR on memory error.
* Returns 0 if it encounters a non-vlan or incomplete packet. * %0 if it encounters a non-vlan or incomplete packet.
* Returns 1 after successfully parsing vlan tag. * %1 after successfully parsing vlan tag.
*/ */
static int parse_vlan_tag(struct sk_buff *skb, struct vlan_head *key_vh, static int parse_vlan_tag(struct sk_buff *skb, struct vlan_head *key_vh,
bool untag_vlan) bool untag_vlan)
@ -532,6 +532,7 @@ static int parse_nsh(struct sk_buff *skb, struct sw_flow_key *key)
* L3 header * L3 header
* @key: output flow key * @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) 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_buff *skb, struct sw_flow_key *key)
* *
* The caller must ensure that skb->len >= ETH_HLEN. * The caller must ensure that skb->len >= ETH_HLEN.
* *
* Returns 0 if successful, otherwise a negative errno value.
*
* Initializes @skb header fields as follows: * Initializes @skb header fields as follows:
* *
* - skb->mac_header: the L2 header. * - skb->mac_header: the L2 header.
@ -764,6 +763,8 @@ static int key_extract_l3l4(struct sk_buff *skb, struct sw_flow_key *key)
* *
* - skb->protocol: the type of the data starting at skb->network_header. * - skb->protocol: the type of the data starting at skb->network_header.
* Equals to key->eth.type. * 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) static int key_extract(struct sk_buff *skb, struct sw_flow_key *key)
{ {