Fix Kernel-doc warnings introduced on next-20200921
Subsystems (5)
cover Fix Kernel-doc warnings introduced on next-20200921
A few new warnings were added at linux-next. Address them, in order for us to keep zero warnings at the docs.
The entire patchset fixing all kernel-doc warnings is at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=doc-fixes
Mauro Carvalho Chehab (3):
net: fix a new kernel-doc warning at dev.c drm/dp: fix kernel-doc warnings at drm_dp_helper.c drm/dp: fix a kernel-doc issue at drm_edid.c
drivers/gpu/drm/drm_dp_helper.c | 5 +++++ drivers/gpu/drm/drm_edid.c | 2 +- net/core/dev.c | 4 ++-- 3 files changed, 8 insertions(+), 3 deletions(-)
Signature · 1 line
2.26.2
PATCH 1/3 net: fix a new kernel-doc warning at dev.c
kernel-doc expects the function prototype to be just after the kernel-doc markup, as otherwise it will get it all wrong:
./net/core/dev.c:10036: warning: Excess function parameter 'dev' description in 'WAIT_REFS_MIN_MSECS'
--- net/core/dev.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
net/core/dev.c +2 -2
@@ -10021,6 +10021,8 @@ int netdev_refcnt_read(const struct net_device *dev) }EXPORT_SYMBOL (netdev_refcnt_read); +#define WAIT_REFS_MIN_MSECS 1 +#define WAIT_REFS_MAX_MSECS 250/** * netdev_wait_allrefs - wait until all references are gone. * @dev: target net_device
@@ -10033,8 +10035,6 @@ EXPORT_SYMBOL(netdev_refcnt_read);* We can get stuck here if buggy protocols don't correctly * call dev_put. */ -#define WAIT_REFS_MIN_MSECS 1 -#define WAIT_REFS_MAX_MSECS 250static void netdev_wait_allrefs (struct net_device *dev) {unsigned long rebroadcast_time, warning_time;
Signature · 1 line
2.26.2
PATCH 2/3 drm/dp: fix kernel-doc warnings at drm_dp_helper.c
In reply to Mauro Carvalho ChehabAs warned by kernel-doc:
./drivers/gpu/drm/drm_dp_helper.c:385: warning: Function parameter or member 'type' not described in 'drm_dp_downstream_is_type' ./drivers/gpu/drm/drm_dp_helper.c:886: warning: Function parameter or member 'dev' not described in 'drm_dp_downstream_mode'
Some function parameters weren't documented.
--- drivers/gpu/drm/drm_dp_helper.c | 5 +++++ 1 file changed, 5 insertions(+)
drivers/gpu/drm/drm_dp_helper.c +5 -0
@@ -374,6 +374,10 @@ static bool is_edid_digital_input_dp(const struct edid *edid)* drm_dp_downstream_is_type() - is the downstream facing port of certain type? * @dpcd: DisplayPort configuration data * @port_cap: port capabilities +* @type: port type to be checked. Can be: +* %DP_DS_PORT_TYPE_DP, %DP_DS_PORT_TYPE_VGA, %DP_DS_PORT_TYPE_DVI, +* %DP_DS_PORT_TYPE_HDMI, %DP_DS_PORT_TYPE_NON_EDID, +* %DP_DS_PORT_TYPE_DP_DUALMODE or %DP_DS_PORT_TYPE_WIRELESS. * * Caveat: Only works with DPCD 1.1+ port caps. *
@@ -870,6 +874,7 @@ EXPORT_SYMBOL(drm_dp_downstream_444_to_420_conversion);/** * drm_dp_downstream_mode() - return a mode for downstream facing port +* @dev: DRM device * @dpcd: DisplayPort configuration data * @port_cap: port capabilities *
Signature · 6 lines
2.26.2 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH 3/3 drm/dp: fix a kernel-doc issue at drm_edid.c
In reply to Mauro Carvalho ChehabThe name of the argument is different, causing those warnings:
./drivers/gpu/drm/drm_edid.c:3754: warning: Function parameter or member 'video_code' not described in 'drm_display_mode_from_cea_vic' ./drivers/gpu/drm/drm_edid.c:3754: warning: Excess function parameter 'vic' description in 'drm_display_mode_from_cea_vic'
--- drivers/gpu/drm/drm_edid.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/drm_edid.c +1 -1
@@ -3741,7 +3741,7 @@ drm_add_cmdb_modes(struct drm_connector *connector, u8 svd)/** * drm_display_mode_from_cea_vic() - return a mode for CEA VIC * @dev: DRM device -* @vic: CEA VIC of the mode +* @video_code: CEA VIC of the mode * * Creates a new mode matching the specified CEA VIC. *
Signature · 1 line
2.26.2
For patches 2 and 3:
I'll go ahead and push these to drm-intel-next-queued (since drm-misc-next doesn't have these patches in yet, and the commits these fix were originally merged through drm-intel-next-queued anyway). thanks!
Quoted 16 lines · Mauro Carvalho Chehab
A few new warnings were added at linux-next. Address them, in order for us to keep zero warnings at the docs.
The entire patchset fixing all kernel-doc warnings is at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=doc-fixesMauro Carvalho Chehab (3):
net: fix a new kernel-doc warning atdev.cdrm/dp: fix kernel-doc warnings atdrm_dp_helper.cdrm/dp: fix a kernel-doc issue atdrm_edid.cdrivers/gpu/drm/drm_dp_helper.c | 5 +++++ drivers/gpu/drm/drm_edid.c | 2 +- net/core/dev.c | 4 ++-- 3 files changed, 8 insertions(+), 3 deletions(-)
Signature · 3 lines
Cheers, Lyude Paul (she/her) Software Engineer at Red Hat
Re: [PATCH 1/3] net: fix a new kernel-doc warning at dev.c
In reply to Mauro Carvalho ChehabQuoted 37 lines · Mauro Carvalho Chehab
kernel-doc expects the function prototype to be just after the kernel-doc markup, as otherwise it will get it all wrong:
./net/core/dev.c:10036: warning: Excess function parameter 'dev' description in 'WAIT_REFS_MIN_MSECS'Fixes 0e4be9e57e8c ("net: use exponential backoff in netdev_wait_allrefs")Signed-off-by Mauro Carvalho Chehab <[email protected]>--- net/core/dev.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)net/core/dev.c +2
-3@@ -10021,6 +10021,8 @@ int netdev_refcnt_read(const struct net_device *dev) }EXPORT_SYMBOL (netdev_refcnt_read); +#define WAIT_REFS_MIN_MSECS 1 +#define WAIT_REFS_MAX_MSECS 250/** * netdev_wait_allrefs - wait until all references are gone. * @dev: target net_device @@ -10033,8 +10035,6 @@ EXPORT_SYMBOL(netdev_refcnt_read);* We can get stuck here if buggy protocols don't correctly * call dev_put. */ -#define WAIT_REFS_MIN_MSECS 1 -#define WAIT_REFS_MAX_MSECS 250static void netdev_wait_allrefs (struct net_device *dev) {unsigned long rebroadcast_time, warning_time; --2.26.2
Re: [PATCH 1/3] net: fix a new kernel-doc warning at dev.c
In reply to Mauro Carvalho ChehabQuoted 8 lines · Mauro Carvalho Chehab
kernel-doc expects the function prototype to be just after the kernel-doc markup, as otherwise it will get it all wrong:
./net/core/dev.c:10036: warning: Excess function parameter 'dev' description in 'WAIT_REFS_MIN_MSECS'Fixes 0e4be9e57e8c ("net: use exponential backoff in netdev_wait_allrefs")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Thanks for fixing this!
Quoted 7 lines · Lyude Paul
For patches 2 and 3:
Reviewed-by Lyude Paul <[email protected]>I'll go ahead and push these to drm-intel-next-queued (since drm-misc-next doesn't have these patches in yet, and the commits these fix were originally merged through drm-intel-next-queued anyway). thanks!
Mea culpa. My doc test build was foiled by the sphinx 2 vs. 3 regression and I was too lazy to start downgrading things. Any ETA for getting that fixed btw?
Quoted 22 lines · Mauro Carvalho Chehab
Quoted 16 lines
A few new warnings were added at linux-next. Address them, in order for us to keep zero warnings at the docs.
The entire patchset fixing all kernel-doc warnings is at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=doc-fixesMauro Carvalho Chehab (3):
net: fix a new kernel-doc warning atdev.cdrm/dp: fix kernel-doc warnings atdrm_dp_helper.cdrm/dp: fix a kernel-doc issue atdrm_edid.cdrivers/gpu/drm/drm_dp_helper.c | 5 +++++ drivers/gpu/drm/drm_edid.c | 2 +- net/core/dev.c | 4 ++-- 3 files changed, 8 insertions(+), 3 deletions(-)Signature · 3 lines
Cheers, Lyude Paul (she/her) Software Engineer at Red Hat
Signature · 2 lines
Ville Syrjälä Intel
Jonathan Corbet
maintainerQuoted 3 lines · On Tue, 22 Sep 2020 20:52:06 +0300 Ville Syrjälä…
Mea culpa. My doc test build was foiled by the sphinx 2 vs. 3 regression and I was too lazy to start downgrading things. Any ETA for getting that fixed btw?
There's a fix of sorts in docs-next (and thus linux-next) now, has been there for a few weeks. Really fixing that problem properly requires more time than anybody seems to have at the moment.
jon
Re: [PATCH 1/3] net: fix a new kernel-doc warning at dev.c
In reply to Mauro Carvalho ChehabFrom: Mauro Carvalho Chehab <[email protected]>
Date: Tue, 22 Sep 2020 13:22:52 +0200
Quoted 7 lines
kernel-doc expects the function prototype to be just after the kernel-doc markup, as otherwise it will get it all wrong:
./net/core/dev.c:10036: warning: Excess function parameter 'dev' description in 'WAIT_REFS_MIN_MSECS'Fixes 0e4be9e57e8c ("net: use exponential backoff in netdev_wait_allrefs")Signed-off-by Mauro Carvalho Chehab <[email protected]>
Applied to net-next.