* Patch to correct kernel-doc comments in networking subsystem
@ 2020-06-21 2:22 Colton Lewis
2020-06-21 2:22 ` [PATCH 1/3] net: core: correct trivial kernel-doc inconsistencies Colton Lewis
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Colton Lewis @ 2020-06-21 2:22 UTC (permalink / raw)
To: davem; +Cc: netdev
This patch was sent to Dave last week, but I fear it may have been
ignored because I forgot to set the subject line. Please accept or
comment on this patch.
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH 1/3] net: core: correct trivial kernel-doc inconsistencies
2020-06-21 2:22 Patch to correct kernel-doc comments in networking subsystem Colton Lewis
@ 2020-06-21 2:22 ` Colton Lewis
2020-06-21 2:22 ` [PATCH 2/3] " Colton Lewis
2020-06-21 2:23 ` [PATCH 3/3] net: phylink: " Colton Lewis
2 siblings, 0 replies; 4+ messages in thread
From: Colton Lewis @ 2020-06-21 2:22 UTC (permalink / raw)
To: davem; +Cc: netdev, Colton Lewis
Silence documentation build warnings by correcting kernel-doc comments.
./net/core/dev.c:7913: warning: Function parameter or member 'dev' not described in 'netdev_get_xmit_slave'
Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
net/core/dev.c | 1 +
1 file changed, 1 insertion(+)
diff --git a/net/core/dev.c b/net/core/dev.c
index 6bc2388141f6..cf20d286abfc 100644
--- a/net/core/dev.c
+++ b/net/core/dev.c
@@ -7898,6 +7898,7 @@ EXPORT_SYMBOL(netdev_bonding_info_change);
/**
* netdev_get_xmit_slave - Get the xmit slave of master device
+ * @dev: The device
* @skb: The packet
* @all_slaves: assume all the slaves are active
*
--
2.26.2
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH 2/3] net: core: correct trivial kernel-doc inconsistencies
2020-06-21 2:22 Patch to correct kernel-doc comments in networking subsystem Colton Lewis
2020-06-21 2:22 ` [PATCH 1/3] net: core: correct trivial kernel-doc inconsistencies Colton Lewis
@ 2020-06-21 2:22 ` Colton Lewis
2020-06-21 2:23 ` [PATCH 3/3] net: phylink: " Colton Lewis
2 siblings, 0 replies; 4+ messages in thread
From: Colton Lewis @ 2020-06-21 2:22 UTC (permalink / raw)
To: davem; +Cc: netdev, Colton Lewis
Silence documentation build warnings by correcting kernel-doc comments.
./include/linux/netdevice.h:2138: warning: Function parameter or member 'napi_defer_hard_irqs' not described in 'net_device'
Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
include/linux/netdevice.h | 1 +
1 file changed, 1 insertion(+)
diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index 6fc613ed8eae..515791a9b299 100644
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -1742,6 +1742,7 @@ enum netdev_priv_flags {
* @real_num_rx_queues: Number of RX queues currently active in device
* @xdp_prog: XDP sockets filter program pointer
* @gro_flush_timeout: timeout for GRO layer in NAPI
+ * @napi_defer_hard_irqs: count of deferred hardware interrupt requests
*
* @rx_handler: handler for received packets
* @rx_handler_data: XXX: need comments on this one
--
2.26.2
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH 3/3] net: phylink: correct trivial kernel-doc inconsistencies
2020-06-21 2:22 Patch to correct kernel-doc comments in networking subsystem Colton Lewis
2020-06-21 2:22 ` [PATCH 1/3] net: core: correct trivial kernel-doc inconsistencies Colton Lewis
2020-06-21 2:22 ` [PATCH 2/3] " Colton Lewis
@ 2020-06-21 2:23 ` Colton Lewis
2 siblings, 0 replies; 4+ messages in thread
From: Colton Lewis @ 2020-06-21 2:23 UTC (permalink / raw)
To: davem; +Cc: netdev, Colton Lewis
Silence documentation build warnings by correcting kernel-doc
comments. In the case of pcs_{config,an_restart,link_up}, change the
declaration to a normal function since these only there for
documentation anyway.
./include/linux/phylink.h:74: warning: Function parameter or member 'poll_fixed_state' not described in 'phylink_config'
./include/linux/phylink.h:74: warning: Function parameter or member 'get_fixed_state' not described in 'phylink_config'
./include/linux/phylink.h:336: warning: Function parameter or member 'pcs_config' not described in 'int'
./include/linux/phylink.h:336: warning: Excess function parameter 'config' description in 'int'
./include/linux/phylink.h:336: warning: Excess function parameter 'mode' description in 'int'
./include/linux/phylink.h:336: warning: Excess function parameter 'interface' description in 'int'
./include/linux/phylink.h:336: warning: Excess function parameter 'advertising' description in 'int'
./include/linux/phylink.h:345: warning: Function parameter or member 'pcs_an_restart' not described in 'void'
./include/linux/phylink.h:345: warning: Excess function parameter 'config' description in 'void'
./include/linux/phylink.h:361: warning: Function parameter or member 'pcs_link_up' not described in 'void'
./include/linux/phylink.h:361: warning: Excess function parameter 'config' description in 'void'
./include/linux/phylink.h:361: warning: Excess function parameter 'mode' description in 'void'
./include/linux/phylink.h:361: warning: Excess function parameter 'interface' description in 'void'
./include/linux/phylink.h:361: warning: Excess function parameter 'speed' description in 'void'
./include/linux/phylink.h:361: warning: Excess function parameter 'duplex' description in 'void'
Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
include/linux/phylink.h | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/include/linux/phylink.h b/include/linux/phylink.h
index cc5b452a184e..cb3230590a1f 100644
--- a/include/linux/phylink.h
+++ b/include/linux/phylink.h
@@ -62,6 +62,8 @@ enum phylink_op_type {
* @dev: a pointer to a struct device associated with the MAC
* @type: operation type of PHYLINK instance
* @pcs_poll: MAC PCS cannot provide link change interrupt
+ * @poll_fixed_state: poll link state with @get_fixed_state
+ * @get_fixed_state: read link state into struct phylink_link_state
*/
struct phylink_config {
struct device *dev;
@@ -331,7 +333,7 @@ void pcs_get_state(struct phylink_config *config,
*
* For most 10GBASE-R, there is no advertisement.
*/
-int (*pcs_config)(struct phylink_config *config, unsigned int mode,
+int *pcs_config(struct phylink_config *config, unsigned int mode,
phy_interface_t interface, const unsigned long *advertising);
/**
@@ -341,7 +343,7 @@ int (*pcs_config)(struct phylink_config *config, unsigned int mode,
* When PCS ops are present, this overrides mac_an_restart() in &struct
* phylink_mac_ops.
*/
-void (*pcs_an_restart)(struct phylink_config *config);
+void *pcs_an_restart(struct phylink_config *config);
/**
* pcs_link_up() - program the PCS for the resolved link configuration
@@ -356,7 +358,7 @@ void (*pcs_an_restart)(struct phylink_config *config);
* mode without in-band AN needs to be manually configured for the link
* and duplex setting. Otherwise, this should be a no-op.
*/
-void (*pcs_link_up)(struct phylink_config *config, unsigned int mode,
+void *pcs_link_up(struct phylink_config *config, unsigned int mode,
phy_interface_t interface, int speed, int duplex);
#endif
--
2.26.2
^ permalink raw reply related [flat|nested] 4+ messages in thread
end of thread, other threads:[~2020-06-21 2:31 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-06-21 2:22 Patch to correct kernel-doc comments in networking subsystem Colton Lewis
2020-06-21 2:22 ` [PATCH 1/3] net: core: correct trivial kernel-doc inconsistencies Colton Lewis
2020-06-21 2:22 ` [PATCH 2/3] " Colton Lewis
2020-06-21 2:23 ` [PATCH 3/3] net: phylink: " Colton Lewis
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).