Re: [PATCH] USB: drop misleading usb_set_intfdata() kernel doc

[Johan Hovold <johan@kernel.org>]

On Mon, Dec 12, 2022 at 11:19:00AM +0100, Oliver Neukum wrote:
> On 11.12.22 13:06, Johan Hovold wrote:
> 
> > Due to a misunderstanding, a redundant and misleading kernel doc comment
> > for usb_set_intfdata() was recently added which claimed that the driver
> > data pointer must not be cleared during disconnect before "all actions
> > [are] completed", which is both imprecise and incorrect.
> 
> OK, but is that a reason to remove all kerneldoc? Kerneldoc is generally
> a good thing. And if a pointer is NULLed by driver core, that will need
> to be in it. IMHO you'd better just remove the questionable part of the
> kerneldoc.

Yeah, I started off with just rewriting the kernel doc and removing the
obviously incorrect bits, but then there is essentially nothing left of
the documentation.

A driver does not need to care that the pointer is cleared by driver
core after the driver is unbound. The driver is gone.

So this information isn't really useful and trying to document it for
only one of the subsystem wrappers probably only adds to the confusion
(e.g. by signalling that this is in some way relevant information).

Johan