linux-next: build warning after merge of the usb.current tree

linux-next: build warning after merge of the usb.current tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 360 bytes --]

Hi all,

After merging the usb.current tree, today's linux-next build (htmldocs)
produced this warning:

Documentation/driver-api/usb/usb:176: /home/sfr/next/next/drivers/usb/core/hub.c:6040: WARNING: Unknown target name: "pre".

Introduced by commit

  9c6d778800b9 ("USB: core: Prevent nested device-reset calls")

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: linux-next: build warning after merge of the usb.current tree

[Alan Stern]

On Wed, Aug 31, 2022 at 03:24:58PM +1000, Stephen Rothwell wrote:
> Hi all,
> 
> After merging the usb.current tree, today's linux-next build (htmldocs)
> produced this warning:
> 
> Documentation/driver-api/usb/usb:176: /home/sfr/next/next/drivers/usb/core/hub.c:6040: WARNING: Unknown target name: "pre".
> 
> Introduced by commit
> 
>   9c6d778800b9 ("USB: core: Prevent nested device-reset calls")

I don't fully understand this bug report.  Would it be fixed by changing 
"pre_" to "pre_reset()" in the kerneldoc?

Alan Stern

Re: linux-next: build warning after merge of the usb.current tree

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 704 bytes --]

Hi Alan,

On Wed, 31 Aug 2022 10:25:37 -0400 Alan Stern <stern@rowland.harvard.edu> wrote:
>
> On Wed, Aug 31, 2022 at 03:24:58PM +1000, Stephen Rothwell wrote:
> > 
> > After merging the usb.current tree, today's linux-next build (htmldocs)
> > produced this warning:
> > 
> > Documentation/driver-api/usb/usb:176: /home/sfr/next/next/drivers/usb/core/hub.c:6040: WARNING: Unknown target name: "pre".
> > 
> > Introduced by commit
> > 
> >   9c6d778800b9 ("USB: core: Prevent nested device-reset calls")  
> 
> I don't fully understand this bug report.  Would it be fixed by changing 
> "pre_" to "pre_reset()" in the kerneldoc?

I would presume so.

-- 
Cheers,
Stephen Rothwell

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

[PATCH] USB: core: Fix RST error in hub.c

[Alan Stern]

A recent commit added an invalid RST expression to a kerneldoc comment
in hub.c.  The fix is trivial.

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Alan Stern <stern@rowland.harvard.edu>
Fixes: 9c6d778800b9 ("USB: core: Prevent nested device-reset calls")
Cc: <stable@vger.kernel.org>

---


[as1987]


 drivers/usb/core/hub.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Index: usb-devel/drivers/usb/core/hub.c
===================================================================
--- usb-devel.orig/drivers/usb/core/hub.c
+++ usb-devel/drivers/usb/core/hub.c
@@ -6039,7 +6039,7 @@ re_enumerate:
  *
  * Return: The same as for usb_reset_and_verify_device().
  * However, if a reset is already in progress (for instance, if a
- * driver doesn't have pre_ or post_reset() callbacks, and while
+ * driver doesn't have pre_reset() or post_reset() callbacks, and while
  * being unbound or re-bound during the ongoing reset its disconnect()
  * or probe() routine tries to perform a second, nested reset), the
  * routine returns -EINPROGRESS.

Re: [PATCH] USB: core: Fix RST error in hub.c

[Bagas Sanjaya]

On 9/1/22 21:36, Alan Stern wrote:
> A recent commit added an invalid RST expression to a kerneldoc comment
> in hub.c.  The fix is trivial.
>

htmldocs warning at that file successfully fixed, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara