mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Alan Stern <stern@rowland.harvard.edu>
Cc: linux-kernel@vger.kernel.org, linux-usb@vger.kernel.org,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Subject: Re: [PATCH v2] USB: ohci: ohci_pdriver.h: fix missing kernel-doc comments
Date: Mon, 2 Nov 2026 20:07:17 -0800	[thread overview]
Message-ID: <caa02760-9ba8-41f9-9089-3ceca2201c13@infradead.org> (raw)
In-Reply-To: <02148858-defa-4c15-92e5-0ce7029bc000@rowland.harvard.edu>



On 11/2/26 7:49 PM, Alan Stern wrote:
> On Mon, Nov 02, 2026 at 05:47:10PM -0800, Randy Dunlap wrote:
>> Convert comments to kernel-doc format to avoid kernel-doc warnings:
>>
>> Warning: include/linux/usb/ohci_pdriver.h:32 struct member 'power_on'
>>  not described in 'usb_ohci_pdata'
>> Warning: include/linux/usb/ohci_pdriver.h:32 struct member 'power_off'
>>  not described in 'usb_ohci_pdata'
>> Warning: include/linux/usb/ohci_pdriver.h:32 struct member 'power_suspend'
>>  not described in 'usb_ohci_pdata'
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> ---
>> v2: move all kernel-doc comments to before the struct instead of
>>     having them inline insidet the struct. (Alan)
>>
>> Cc: Alan Stern <stern@rowland.harvard.edu>
>> Cc: linux-usb@vger.kernel.org
>> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
>>
>>  include/linux/usb/ohci_pdriver.h |    8 ++++----
>>  1 file changed, 4 insertions(+), 4 deletions(-)
>>
>> --- linux-next-20261102.orig/include/linux/usb/ohci_pdriver.h
>> +++ linux-next-20261102/include/linux/usb/ohci_pdriver.h
>> @@ -13,6 +13,10 @@
>>   * @big_endian_mmio:	BE registers
>>   * @no_big_frame_no:	no big endian frame_no shift
>>   * @num_ports:		number of ports
>> + * @power_on: Turn on all power and clocks
>> + * @power_off: Turn off all power and clocks
>> + * @power_suspend: Turn on only VBUS suspend power and hotplug
>> + *                 detection, turn off everything else
> 
> It would be nice if the indentation for these new entries matched the 
> indentation for the ones above (1 or 2 tabs instead of 1 space).  Aside 
> from that:
> 
> Acked-by: Alan Stern <stern@rowland.harvard.edu>
> 

Agreed. I'll send a v3.
Thanks.

> 
>>   *
>>   * These are general configuration options for the OHCI controller. All of
>>   * these options are activating more or less workarounds for some hardware.
>> @@ -23,12 +27,8 @@ struct usb_ohci_pdata {
>>  	unsigned	no_big_frame_no:1;
>>  	unsigned int	num_ports;
>>  
>> -	/* Turn on all power and clocks */
>>  	int (*power_on)(struct platform_device *pdev);
>> -	/* Turn off all power and clocks */
>>  	void (*power_off)(struct platform_device *pdev);
>> -	/* Turn on only VBUS suspend power and hotplug detection,
>> -	 * turn off everything else */
>>  	void (*power_suspend)(struct platform_device *pdev);
>>  };
>>  

-- 
~Randy


      reply	other threads:[~2026-11-03  4:07 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-03  1:47 Randy Dunlap
2026-11-03  3:49 ` Alan Stern
2026-11-03  4:07   ` Randy Dunlap [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=caa02760-9ba8-41f9-9089-3ceca2201c13@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=stern@rowland.harvard.edu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®