* [PATCH] trivial: scsi: Fix warning on make htmldocs caused by scsi_transport_srp.c
@ 2014-02-03 14:34 Masanari Iida
2014-02-03 14:55 ` Bart Van Assche
0 siblings, 1 reply; 2+ messages in thread
From: Masanari Iida @ 2014-02-03 14:34 UTC (permalink / raw)
To: JBottomley, trivial, linux-scsi, linux-kernel; +Cc: Masanari Iida
This patch fixed following warnings on make htmldocs.
Warning(/drivers/scsi/scsi_transport_srp.c:819):
No description found for parameter 'rport'
Signed-off-by: Masanari Iida <standby24x7@gmail.com>
---
drivers/scsi/scsi_transport_srp.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/drivers/scsi/scsi_transport_srp.c b/drivers/scsi/scsi_transport_srp.c
index d47ffc8..664eb38 100644
--- a/drivers/scsi/scsi_transport_srp.c
+++ b/drivers/scsi/scsi_transport_srp.c
@@ -811,6 +811,8 @@ EXPORT_SYMBOL_GPL(srp_remove_host);
/**
* srp_stop_rport_timers - stop the transport layer recovery timers
*
+ * @rport: SRP remote port to be removed
+ *
* Must be called after srp_remove_host() and scsi_remove_host(). The caller
* must hold a reference on the rport (rport->dev) and on the SCSI host
* (rport->dev.parent).
--
1.9.rc1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] trivial: scsi: Fix warning on make htmldocs caused by scsi_transport_srp.c
2014-02-03 14:34 [PATCH] trivial: scsi: Fix warning on make htmldocs caused by scsi_transport_srp.c Masanari Iida
@ 2014-02-03 14:55 ` Bart Van Assche
0 siblings, 0 replies; 2+ messages in thread
From: Bart Van Assche @ 2014-02-03 14:55 UTC (permalink / raw)
To: Masanari Iida, JBottomley, trivial, linux-scsi, linux-kernel
On 02/03/14 15:34, Masanari Iida wrote:
> This patch fixed following warnings on make htmldocs.
>
> Warning(/drivers/scsi/scsi_transport_srp.c:819):
> No description found for parameter 'rport'
>
> Signed-off-by: Masanari Iida <standby24x7@gmail.com>
> ---
> drivers/scsi/scsi_transport_srp.c | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/drivers/scsi/scsi_transport_srp.c b/drivers/scsi/scsi_transport_srp.c
> index d47ffc8..664eb38 100644
> --- a/drivers/scsi/scsi_transport_srp.c
> +++ b/drivers/scsi/scsi_transport_srp.c
> @@ -811,6 +811,8 @@ EXPORT_SYMBOL_GPL(srp_remove_host);
> /**
> * srp_stop_rport_timers - stop the transport layer recovery timers
> *
> + * @rport: SRP remote port to be removed
> + *
> * Must be called after srp_remove_host() and scsi_remove_host(). The caller
> * must hold a reference on the rport (rport->dev) and on the SCSI host
> * (rport->dev.parent).
The comment added by this patch is wrong. That is easy to see by having
a look at the function name and function description.
In case anyone is wondering why this kerneldoc warning was not addressed
by commit 0c7f821: that patch was prepared against kernel v3.12-rc7 and
the warning reported above is new in kernel v3.14-rc1.
Bart.
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2014-02-03 14:55 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-02-03 14:34 [PATCH] trivial: scsi: Fix warning on make htmldocs caused by scsi_transport_srp.c Masanari Iida
2014-02-03 14:55 ` Bart Van Assche
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox