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

net: openvswitch: fix kernel-doc warnings in internal headers

Some field descriptions were missing, some were not very accurate.
Not touching the uAPI header or .c files for now.

Formatting of those comments isn't great in general, but at least
they are not missing anything now.

Before:
$ ./scripts/kernel-doc -none -Wall net/openvswitch/*.h 2>&1 | wc -l
16

After:
$ ./scripts/kernel-doc -none -Wall net/openvswitch/*.h 2>&1 | wc -l
0

Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
Acked-by: Eelco Chaudron <echaudro@redhat.com>
Reviewed-by: Aaron Conole <aconole@redhat.com>
Link: https://patch.msgid.link/20250320224431.252489-1-i.maximets@ovn.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

authored by

Ilya Maximets and committed by
Jakub Kicinski
6bb0dcb3 ca1914a3

+23 -6
+14 -6
net/openvswitch/datapath.h
··· 29 29 * datapath. 30 30 * @n_hit: Number of received packets for which a matching flow was found in 31 31 * the flow table. 32 - * @n_miss: Number of received packets that had no matching flow in the flow 33 - * table. The sum of @n_hit and @n_miss is the number of packets that have 32 + * @n_missed: Number of received packets that had no matching flow in the flow 33 + * table. The sum of @n_hit and @n_missed is the number of packets that have 34 34 * been received by the datapath. 35 35 * @n_lost: Number of received packets that had no matching flow in the flow 36 36 * table that could not be sent to userspace (normally due to an overflow in ··· 40 40 * up per packet. 41 41 * @n_cache_hit: The number of received packets that had their mask found using 42 42 * the mask cache. 43 + * @syncp: Synchronization point for 64bit counters. 43 44 */ 44 45 struct dp_stats_percpu { 45 46 u64 n_hit; ··· 75 74 * ovs_mutex and RCU. 76 75 * @stats_percpu: Per-CPU datapath statistics. 77 76 * @net: Reference to net namespace. 78 - * @max_headroom: the maximum headroom of all vports in this datapath; it will 77 + * @user_features: Bitmap of enabled %OVS_DP_F_* features. 78 + * @max_headroom: The maximum headroom of all vports in this datapath; it will 79 79 * be used by all the internal vports in this dp. 80 + * @meter_tbl: Meter table. 80 81 * @upcall_portids: RCU protected 'struct dp_nlsk_pids'. 81 82 * 82 83 * Context: See the comment on locking at the top of datapath.c for additional ··· 131 128 #define OVS_CB(skb) ((struct ovs_skb_cb *)(skb)->cb) 132 129 133 130 /** 134 - * struct dp_upcall - metadata to include with a packet to send to userspace 131 + * struct dp_upcall_info - metadata to include with a packet sent to userspace 135 132 * @cmd: One of %OVS_PACKET_CMD_*. 136 133 * @userdata: If nonnull, its variable-length value is passed to userspace as 137 134 * %OVS_PACKET_ATTR_USERDATA. 135 + * @actions: If nonnull, its variable-length value is passed to userspace as 136 + * %OVS_PACKET_ATTR_ACTIONS. 137 + * @actions_len: The length of the @actions. 138 138 * @portid: Netlink portid to which packet should be sent. If @portid is 0 139 139 * then no packet is sent and the packet is accounted in the datapath's @n_lost 140 140 * counter. ··· 158 152 * struct ovs_net - Per net-namespace data for ovs. 159 153 * @dps: List of datapaths to enable dumping them all out. 160 154 * Protected by genl_mutex. 155 + * @dp_notify_work: A work notifier to handle port unregistering. 156 + * @masks_rebalance: A work to periodically optimize flow table caches. 157 + * @ct_limit_info: A hash table of conntrack zone connection limits. 158 + * @xt_label: Whether connlables are configured for the network or not. 161 159 */ 162 160 struct ovs_net { 163 161 struct list_head dps; ··· 170 160 #if IS_ENABLED(CONFIG_NETFILTER_CONNCOUNT) 171 161 struct ovs_ct_limit_info *ct_limit_info; 172 162 #endif 173 - 174 - /* Module reference for configuring conntrack. */ 175 163 bool xt_label; 176 164 }; 177 165
+9
net/openvswitch/vport.h
··· 97 97 * @desired_ifindex: New vport's ifindex. 98 98 * @dp: New vport's datapath. 99 99 * @port_no: New vport's port number. 100 + * @upcall_portids: %OVS_VPORT_ATTR_UPCALL_PID attribute from Netlink message, 101 + * %NULL if none was supplied. 100 102 */ 101 103 struct vport_parms { 102 104 const char *name; ··· 127 125 * have any configuration. 128 126 * @send: Send a packet on the device. 129 127 * zero for dropped packets or negative for error. 128 + * @owner: Module that implements this vport type. 129 + * @list: List entry in the global list of vport types. 130 130 */ 131 131 struct vport_ops { 132 132 enum ovs_vport_type type; ··· 148 144 /** 149 145 * struct vport_upcall_stats_percpu - per-cpu packet upcall statistics for 150 146 * a given vport. 147 + * @syncp: Synchronization point for 64bit counters. 151 148 * @n_success: Number of packets that upcall to userspace succeed. 152 149 * @n_fail: Number of packets that upcall to userspace failed. 153 150 */ ··· 169 164 * 170 165 * @vport: vport to access 171 166 * 167 + * Returns: A void pointer to a private data allocated in the @vport. 168 + * 172 169 * If a nonzero size was passed in priv_size of vport_alloc() a private data 173 170 * area was allocated on creation. This allows that area to be accessed and 174 171 * used for any purpose needed by the vport implementer. ··· 184 177 * vport_from_priv - lookup vport from private data pointer 185 178 * 186 179 * @priv: Start of private data area. 180 + * 181 + * Returns: A reference to a vport structure that contains @priv. 187 182 * 188 183 * It is sometimes useful to translate from a pointer to the private data 189 184 * area to the vport, such as in the case where the private data pointer is