Re: [PATCH v3] PCI: hotplug: Fix kernel-doc formatting and add missing documentation

[Krzysztof Wilczy??ski <kw@linux.com>]

Hi Lukas,

Thank you for feedback!

[...]
> I respectfully submit that the formatting is fine and there's nothing
> to be "fixed" here (as the commit message claims).

The fixing it probably more relevant to the two first hunks, everything
else would be more of a style update so that kernel-doc is kept with the
following guideline:
  https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html

Which is something other users of kernel-doc seldom embrace as I could
only find a handful of places where this format is somewhat followed.

Thus, like you say, keeping the scope of changes to only updating what
matters would be more appropriate.  I will send another revision that
does exactly that.

> > + * @inband_presence_disabled:	Flag to used to track whether the in-band
> > + *				presence detection is disabled.
> 
> That's not proper English and also not very useful because the documentation
> merely repeats what the flag's name says.  I'd suggest something along the
> lines of:
>  * @inband_presence_disabled: whether In-Band Presence Detect Disable is
>  *	supported by the controller and disabled per spec recommendation
>  *	(PCIe r5.0, appendix I implementation note)

Thank you!  I will use your version going forward.

	Krzysztof