2015-07-16 21:07:51

by Tyrel Datwyler

[permalink] [raw]
Subject: Re: [PATCH] ibmvscsi:Remove no longer required comments about return values in the file ibmvfc.c

On 07/09/2015 10:41 AM, Nicholas Krause wrote:
> This removes the no longer require comments about the return values
> for the functions ibmvfc_init_host and ibmvfc_reinit_host due to
> these functions being declared to have a return type of void thus
> making this comments invalid.
>
> Signed-off-by: Nicholas Krause <[email protected]>

Some grammar nit picking. Aside from a couple spelling errors the
wording is a little difficult. Refer to Documentation/SubmittingPatches
section 2. In particular it suggests using the imperative mood.
Something like this would work better:

"Remove comments about return values from ibmvfc_init_host() and
ibmvfc_reinit_host() as they are both declared to have return type void."

Otherwise,

Acked-by: Tyrel Datwyler <[email protected]>

> ---
> drivers/scsi/ibmvscsi/ibmvfc.c | 4 ----
> 1 file changed, 4 deletions(-)
>
> diff --git a/drivers/scsi/ibmvscsi/ibmvfc.c b/drivers/scsi/ibmvscsi/ibmvfc.c
> index 057d277..c6582db 100644
> --- a/drivers/scsi/ibmvscsi/ibmvfc.c
> +++ b/drivers/scsi/ibmvscsi/ibmvfc.c
> @@ -528,8 +528,6 @@ static void ibmvfc_set_host_action(struct ibmvfc_host *vhost,
> * ibmvfc_reinit_host - Re-start host initialization (no NPIV Login)
> * @vhost: ibmvfc host struct
> *
> - * Return value:
> - * nothing
> **/
> static void ibmvfc_reinit_host(struct ibmvfc_host *vhost)
> {
> @@ -570,8 +568,6 @@ static void ibmvfc_link_down(struct ibmvfc_host *vhost,
> * ibmvfc_init_host - Start host initialization
> * @vhost: ibmvfc host struct
> *
> - * Return value:
> - * nothing
> **/
> static void ibmvfc_init_host(struct ibmvfc_host *vhost)
> {
>