Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Sun, 2 Apr 2023 17:36:33 +0200
From:   Greg KH <gregkh@linuxfoundation.org>
To:     Dalvin-Ehinoma Noah Aiguobas <pharcodra@gmail.com>
Cc:     linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] staging: wlan-ng: add comment to spinlock_t
Message-ID: <2023040231-lyricist-retouch-37d9@gregkh>
References: <20230402153244.GA12609@koolguy>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20230402153244.GA12609@koolguy>
Precedence: bulk

On Sun, Apr 02, 2023 at 05:32:44PM +0200, Dalvin-Ehinoma Noah Aiguobas wrote:
> Fix checkpatch.pl warning: spinlock_t definition without comment in
> drivers/staging/wlan-ng/hfa384x.h
> 
> Signed-off-by: Dalvin-Ehinoma Noah Aiguobas <pharcodra@gmail.com>
> ---
>  drivers/staging/wlan-ng/hfa384x.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/staging/wlan-ng/hfa384x.h b/drivers/staging/wlan-ng/hfa384x.h
> index e33dd1b9c40e..fc6d67cec5b1 100644
> --- a/drivers/staging/wlan-ng/hfa384x.h
> +++ b/drivers/staging/wlan-ng/hfa384x.h
> @@ -1000,7 +1000,7 @@ struct hfa384x_usbctlx {
>  };
>  
>  struct hfa384x_usbctlxq {
> -	spinlock_t lock;
> +	spinlock_t lock;	/* disable interrupts while working in hfa384 or hfa384x_usbctlx */

Disable interrupts?  Are you sure that is what this lock is doing?
And what exactly does "while working in..." mean?

Why not just write real kernel doc for all of the fields in this
structure?

thanks,

greg k-h