netdev - Re: [LINUX PATCH] net: axienet: Fix axiethernet register description

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: <cbd29d03-c9bc-4714-b008-ceef9380c46c@lunn.ch>
Date: Sat, 13 Jul 2024 16:54:36 +0200
From: Andrew Lunn <andrew@...n.ch>
To: Suraj Gupta <suraj.gupta2@....com>
Cc: radhey.shyam.pandey@....com, davem@...emloft.net, edumazet@...gle.com,
	kuba@...nel.org, pabeni@...hat.com, michal.simek@....com,
	netdev@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
	linux-kernel@...r.kernel.org, git@....com, harini.katakam@....com
Subject: Re: [LINUX PATCH] net: axienet: Fix axiethernet register description

On Sat, Jul 13, 2024 at 06:48:07PM +0530, Suraj Gupta wrote:
> Rename axiethernet register description to be inline with product guide
> register names. It also removes obsolete registers and bitmasks. There is
> no functional impact since the modified offsets are only renamed.
> 
> Rename XAE_PHYC_OFFSET->XAE_RMFC_OFFSET (Only used in ethtool get_regs)
> XAE_MDIO_* : update documentation comment.
> Remove unused Bit masks for Axi Ethernet PHYC register.
> Remove bit masks for MDIO interface MIS, MIP, MIE, MIC registers.
> Rename XAE_FMI -> XAE_FMC.

Might be too way out there, but why not modify the documentation to
fit Linux? This driver is likely to get bug fixes, and renames like
this make it harder to backport those fixes. Documentation on the
other hand just tends to get erratas, either in a separate document,
or appended to the beginning/end. There is no applying patches to
documentation.

	Andrew