| Message ID | 20201215063750.3120976-1-kuba@kernel.org (mailing list archive) |
|---|---|
| State | Accepted |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | [net-next] phy: fix kdoc warning | expand |
| Context | Check | Description |
|---|---|---|
| netdev/cover_letter | success | Link |
| netdev/fixes_present | success | Link |
| netdev/patch_count | success | Link |
| netdev/tree_selection | success | Clearly marked for net-next |
| netdev/subject_prefix | success | Link |
| netdev/source_inline | success | Was 0 now: 0 |
| netdev/verify_signedoff | success | Link |
| netdev/module_param | success | Was 0 now: 0 |
| netdev/build_32bit | success | Errors and warnings before: 625 this patch: 625 |
| netdev/kdoc | success | Errors and warnings before: 1 this patch: 0 |
| netdev/verify_fixes | success | Link |
| netdev/checkpatch | success | total: 0 errors, 0 warnings, 0 checks, 9 lines checked |
| netdev/build_allmodconfig_warn | success | Errors and warnings before: 541 this patch: 541 |
| netdev/header_inline | success | Link |
| netdev/stable | success | Stable not CCed |
On Mon, 14 Dec 2020 22:37:50 -0800 Jakub Kicinski wrote: > Kdoc does not like it when multiline comment follows the networking > style of starting right on the first line: > > include/linux/phy.h:869: warning: Function parameter or member 'config_intr' not described in 'phy_driver' > > Signed-off-by: Jakub Kicinski <kuba@kernel.org> Applied.
diff --git a/include/linux/phy.h b/include/linux/phy.h index 381a95732b6a..9effb511acde 100644 --- a/include/linux/phy.h +++ b/include/linux/phy.h @@ -741,11 +741,12 @@ struct phy_driver { int (*aneg_done)(struct phy_device *phydev); /** @read_status: Determines the negotiated speed and duplex */ int (*read_status)(struct phy_device *phydev); - /** @config_intr: Enables or disables interrupts. + /** + * @config_intr: Enables or disables interrupts. * It should also clear any pending interrupts prior to enabling the * IRQs and after disabling them. */ int (*config_intr)(struct phy_device *phydev);
Kdoc does not like it when multiline comment follows the networking style of starting right on the first line: include/linux/phy.h:869: warning: Function parameter or member 'config_intr' not described in 'phy_driver' Signed-off-by: Jakub Kicinski <kuba@kernel.org> --- include/linux/phy.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)