Re: [PATCH] net: phy: Remove unnecessary indentation in the comments of phy_device

Russell King (Oracle) [off-list ref] 于2021年12月5日周日 21:45写道：

On Sun, Dec 05, 2021 at 09:21:41PM +0800, Yanteng Si wrote:

quoted

Fix warning as:

linux-next/Documentation/networking/kapi:122: ./include/linux/phy.h:543: WARNING: Unexpected indentation.
linux-next/Documentation/networking/kapi:122: ./include/linux/phy.h:544: WARNING: Block quote ends without a blank line; unexpected unindent.
linux-next/Documentation/networking/kapi:122: ./include/linux/phy.h:546: WARNING: Unexpected indentation.

This seems to be at odds with the documentation in
Documentation/doc-guide/kernel-doc.rst.

The warning refers to lines 543, 544 and 546.

543: *              Bits [23:16] are currently reserved for future use.
544: *              Bits [31:24] are reserved for defining generic
545: *                           PHY driver behavior.
546: * @irq: IRQ number of the PHY's interrupt (-1 if none)

This doesn't look quite right with the warning messages above, because
544 doesn't unindent, and I've checked net-next, net, and mainline
trees, and they're all the same.

They are not always precise.

So, I think we first need to establish exactly which lines you are
seeing this warning for before anyone can make a suggestion.

Dear Russell

My configuration environment and operation steps are as follows：

[siyanteng@sterling]$ cd linux-next
[siyanteng@sterling]$ ./scripts/sphinx-pre-install
Detected OS: CentOS Linux release 8.5.2111.
Sphinx version: 2.4.4


All optional dependencies are met.
Needed package dependencies are met.
[siyanteng@sterling]$ . sphinx_2.4.4/bin/activate
(sphinx_2.4.4) [siyanteng@sterling]$ make cleandocs
(sphinx_2.4.4) [siyanteng@sterling]$ make htmldocs

Thanks，
Yanteng