]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/commitdiff
net/mlx5e: Fix port buffer function documentation format
authorSaeed Mahameed <saeedm@mellanox.com>
Thu, 21 Mar 2019 22:51:32 +0000 (15:51 -0700)
committerSaeed Mahameed <saeedm@mellanox.com>
Fri, 22 Mar 2019 19:09:30 +0000 (12:09 -0700)
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>
drivers/net/ethernet/mellanox/mlx5/core/en/port_buffer.c

index eac245a93f918c588dc8237e1af5996f3d0f73f0..b0ce68feb0f33eafe746ab5993e4d62362a7f06f 100644 (file)
@@ -165,23 +165,23 @@ static int update_xoff_threshold(struct mlx5e_port_buffer *port_buffer,
 }
 
 /**
- * update_buffer_lossy()
- *   mtu: device's MTU
- *   pfc_en: <input> current pfc configuration
- *   buffer: <input> current prio to buffer mapping
- *   xoff:   <input> xoff value
- *   port_buffer: <output> port receive buffer configuration
- *   change: <output>
+ *     update_buffer_lossy     - Update buffer configuration based on pfc
+ *     @mtu: device's MTU
+ *     @pfc_en: <input> current pfc configuration
+ *     @buffer: <input> current prio to buffer mapping
+ *     @xoff:   <input> xoff value
+ *     @port_buffer: <output> port receive buffer configuration
+ *     @change: <output>
  *
- *   Update buffer configuration based on pfc configuraiton and priority
- *   to buffer mapping.
- *   Buffer's lossy bit is changed to:
- *     lossless if there is at least one PFC enabled priority mapped to this buffer
- *     lossy if all priorities mapped to this buffer are PFC disabled
+ *     Update buffer configuration based on pfc configuraiton and
+ *     priority to buffer mapping.
+ *     Buffer's lossy bit is changed to:
+ *             lossless if there is at least one PFC enabled priority
+ *             mapped to this buffer lossy if all priorities mapped to
+ *             this buffer are PFC disabled
  *
- *   Return:
- *     Return 0 if no error.
- *     Set change to true if buffer configuration is modified.
+ *     @return: 0 if no error,
+ *     sets change to true if buffer configuration was modified.
  */
 static int update_buffer_lossy(unsigned int mtu,
                               u8 pfc_en, u8 *buffer, u32 xoff,