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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <YazChnNvaEMHzCQG@shell.armlinux.org.uk>
Date:   Sun, 5 Dec 2021 13:45:42 +0000
From:   "Russell King (Oracle)" <linux@...linux.org.uk>
To:     Yanteng Si <siyanteng01@...il.com>
Cc:     andrew@...n.ch, hkallweit1@...il.com, netdev@...r.kernel.org,
        corbet@....net, chenhuacai@...nel.org, linux-doc@...r.kernel.org,
        Yanteng Si <siyanteng@...ngson.cn>
Subject: Re: [PATCH] net: phy: Remove unnecessary indentation in the comments
 of phy_device

On Sun, Dec 05, 2021 at 09:21:41PM +0800, Yanteng Si wrote:
> 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.

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

-- 
RMK's Patch system: https://www.armlinux.org.uk/developer/patches/
FTTP is here! 40Mbps down 10Mbps up. Decent connectivity at last!