| Message ID | 4a6bf33cfbd06654d78294127f2b6d354d073089.1610610937.git.mchehab+huawei@kernel.org (mailing list archive) |
|---|---|
| State | Accepted, archived |
| Headers | show |
| Series | Fix several bad kernel-doc markups | expand |
On 1/14/21 9:04 AM, Mauro Carvalho Chehab wrote: > A function has a different name between their prototype > and its kernel-doc markup: > > ../drivers/platform/surface/aggregator/ssh_request_layer.c:1065: warning: expecting prototype for ssh_rtl_tx_start(). Prototype was for ssh_rtl_start() instead > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> > --- > drivers/platform/surface/aggregator/ssh_request_layer.c | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/drivers/platform/surface/aggregator/ssh_request_layer.c b/drivers/platform/surface/aggregator/ssh_request_layer.c > index bb1c862411a2..25db4d638cfa 100644 > --- a/drivers/platform/surface/aggregator/ssh_request_layer.c > +++ b/drivers/platform/surface/aggregator/ssh_request_layer.c > @@ -1056,7 +1056,7 @@ void ssh_rtl_destroy(struct ssh_rtl *rtl) > } > > /** > - * ssh_rtl_tx_start() - Start request transmitter and receiver. > + * ssh_rtl_start() - Start request transmitter and receiver. > * @rtl: The request transport layer. > * > * Return: Returns zero on success, a negative error code on failure. > Thanks! Looks good to me. Reviewed-by: Maximilian Luz <luzmaximilian@gmail.com> There seems to be another issue similar to this, specifically the non-existing ssh_rtl_tx_start() and ssh_rtl_tx_start() are referenced. Both should point to to ssh_rtl_start() instead. I'll start working on a patch to fix that right away. Regards, Max
Hi, On 1/14/21 9:04 AM, Mauro Carvalho Chehab wrote: > A function has a different name between their prototype > and its kernel-doc markup: > > ../drivers/platform/surface/aggregator/ssh_request_layer.c:1065: warning: expecting prototype for ssh_rtl_tx_start(). Prototype was for ssh_rtl_start() instead > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Thank you for your patch, I've applied this patch to my review-hans branch: https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans Note it will show up in my review-hans branch once I've pushed my local branch there, which might take a while. Once I've run some tests on this branch the patches there will be added to the platform-drivers-x86/for-next branch and eventually will be included in the pdx86 pull-request to Linus for the next merge-window. Regards, Hans > --- > drivers/platform/surface/aggregator/ssh_request_layer.c | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/drivers/platform/surface/aggregator/ssh_request_layer.c b/drivers/platform/surface/aggregator/ssh_request_layer.c > index bb1c862411a2..25db4d638cfa 100644 > --- a/drivers/platform/surface/aggregator/ssh_request_layer.c > +++ b/drivers/platform/surface/aggregator/ssh_request_layer.c > @@ -1056,7 +1056,7 @@ void ssh_rtl_destroy(struct ssh_rtl *rtl) > } > > /** > - * ssh_rtl_tx_start() - Start request transmitter and receiver. > + * ssh_rtl_start() - Start request transmitter and receiver. > * @rtl: The request transport layer. > * > * Return: Returns zero on success, a negative error code on failure. >
diff --git a/drivers/platform/surface/aggregator/ssh_request_layer.c b/drivers/platform/surface/aggregator/ssh_request_layer.c index bb1c862411a2..25db4d638cfa 100644 --- a/drivers/platform/surface/aggregator/ssh_request_layer.c +++ b/drivers/platform/surface/aggregator/ssh_request_layer.c @@ -1056,7 +1056,7 @@ void ssh_rtl_destroy(struct ssh_rtl *rtl) } /** - * ssh_rtl_tx_start() - Start request transmitter and receiver. + * ssh_rtl_start() - Start request transmitter and receiver. * @rtl: The request transport layer. * * Return: Returns zero on success, a negative error code on failure.
A function has a different name between their prototype and its kernel-doc markup: ../drivers/platform/surface/aggregator/ssh_request_layer.c:1065: warning: expecting prototype for ssh_rtl_tx_start(). Prototype was for ssh_rtl_start() instead Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> --- drivers/platform/surface/aggregator/ssh_request_layer.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)