diff mbox series

[net] net: ethtool: Add missing kernel doc for FEC parameters

Message ID 20180421231848.17450-1-f.fainelli@gmail.com
State Changes Requested, archived
Delegated to: David Miller
Headers show
Series [net] net: ethtool: Add missing kernel doc for FEC parameters | expand

Commit Message

Florian Fainelli April 21, 2018, 11:18 p.m. UTC
While adding support for ethtool::get_fecparam and set_param, kernel doc for
these functions was missed, add those.

Fixes: 1a5f3da20bd9 ("net: ethtool: add support for forward error correction modes")
Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
---
 include/linux/ethtool.h | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Sergei Shtylyov April 22, 2018, 8:51 a.m. UTC | #1
Hello!

On 4/22/2018 2:18 AM, Florian Fainelli wrote:

> While adding support for ethtool::get_fecparam and set_param, kernel doc for

    set_fecparam.

> these functions was missed, add those.
> 
> Fixes: 1a5f3da20bd9 ("net: ethtool: add support for forward error correction modes")
> Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
[...]

MBR, Sergei
David Miller April 23, 2018, 2:28 p.m. UTC | #2
From: Florian Fainelli <f.fainelli@gmail.com>
Date: Sat, 21 Apr 2018 16:18:48 -0700

> + * @sec_fecparam: Set the network device Forward Error Correction

As Sergei pointed out this should be "set_fecparam"
diff mbox series

Patch

diff --git a/include/linux/ethtool.h b/include/linux/ethtool.h
index ebe41811ed34..f95d47b4d545 100644
--- a/include/linux/ethtool.h
+++ b/include/linux/ethtool.h
@@ -310,6 +310,10 @@  bool ethtool_convert_link_mode_to_legacy_u32(u32 *legacy_u32,
  *	fields should be ignored (use %__ETHTOOL_LINK_MODE_MASK_NBITS
  *	instead of the latter), any change to them will be overwritten
  *	by kernel. Returns a negative error code or zero.
+ * @get_fecparam: Get the network device Forward Error Correction
+ *	parameters.
+ * @sec_fecparam: Set the network device Forward Error Correction
+ *	parameters.
  *
  * All operations are optional (i.e. the function pointer may be set
  * to %NULL) and callers must take this into account.  Callers must