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

net/mlx5e: Fix port buffer function documentation format

This patch fixes compiler warnings:
In drivers/.../mlx5/core/en/port_buffer.c:190:
warning: Function parameter or member 'pfc_en' not described...
...
warning: Function parameter or member 'change' not described...

Fixes: 0696d60853d5 ("net/mlx5e: Receive buffer configuration")
Reviewed-by: Eran Ben Elisha <eranbe@mellanox.com>
Signed-off-by: Saeed Mahameed <saeedm@mellanox.com>

+15 -15
+15 -15
drivers/net/ethernet/mellanox/mlx5/core/en/port_buffer.c
··· 165 165 } 166 166 167 167 /** 168 - * update_buffer_lossy() 169 - * mtu: device's MTU 170 - * pfc_en: <input> current pfc configuration 171 - * buffer: <input> current prio to buffer mapping 172 - * xoff: <input> xoff value 173 - * port_buffer: <output> port receive buffer configuration 174 - * change: <output> 168 + * update_buffer_lossy - Update buffer configuration based on pfc 169 + * @mtu: device's MTU 170 + * @pfc_en: <input> current pfc configuration 171 + * @buffer: <input> current prio to buffer mapping 172 + * @xoff: <input> xoff value 173 + * @port_buffer: <output> port receive buffer configuration 174 + * @change: <output> 175 175 * 176 - * Update buffer configuration based on pfc configuraiton and priority 177 - * to buffer mapping. 178 - * Buffer's lossy bit is changed to: 179 - * lossless if there is at least one PFC enabled priority mapped to this buffer 180 - * lossy if all priorities mapped to this buffer are PFC disabled 176 + * Update buffer configuration based on pfc configuraiton and 177 + * priority to buffer mapping. 178 + * Buffer's lossy bit is changed to: 179 + * lossless if there is at least one PFC enabled priority 180 + * mapped to this buffer lossy if all priorities mapped to 181 + * this buffer are PFC disabled 181 182 * 182 - * Return: 183 - * Return 0 if no error. 184 - * Set change to true if buffer configuration is modified. 183 + * @return: 0 if no error, 184 + * sets change to true if buffer configuration was modified. 185 185 */ 186 186 static int update_buffer_lossy(unsigned int mtu, 187 187 u8 pfc_en, u8 *buffer, u32 xoff,