[net-next,2/2] net: ethernet: renesas: drop SoC names in Kconfig

Message ID 20231022205316.3209-3-wsa+renesas@sang-engineering.com
State New
Headers
Series net: ethernet: renesas: infrastructure preparations for upcoming driver |

Commit Message

Wolfram Sang Oct. 22, 2023, 8:53 p.m. UTC
  Mentioning SoCs in Kconfig descriptions tends to get stale (e.g. RAVB is
missing RZV2M) or imprecise (e.g. SH_ETH is not available on all
R8A779x). Drop them instead of providing vague information. Improve the
file description a tad while here.

Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
---
 drivers/net/ethernet/renesas/Kconfig | 9 +--------
 1 file changed, 1 insertion(+), 8 deletions(-)
  

Comments

Sergey Shtylyov Oct. 23, 2023, 8:48 a.m. UTC | #1
On 10/22/23 11:53 PM, Wolfram Sang wrote:

> Mentioning SoCs in Kconfig descriptions tends to get stale (e.g. RAVB is
> missing RZV2M) or imprecise (e.g. SH_ETH is not available on all
> R8A779x). Drop them instead of providing vague information. Improve the
> file description a tad while here.
> 
> Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>

Reviewed-by: Sergey Shtylyov <s.shtylyov@omp.ru>

[...]

MBR, Sergey
  
Paolo Abeni Oct. 24, 2023, 10:53 a.m. UTC | #2
On Sun, 2023-10-22 at 22:53 +0200, Wolfram Sang wrote:
> Mentioning SoCs in Kconfig descriptions tends to get stale (e.g. RAVB is
> missing RZV2M) or imprecise (e.g. SH_ETH is not available on all
> R8A779x). Drop them instead of providing vague information. Improve the
> file description a tad while here.

It's not a big deal, but assuming that keeping the SoC list up2date
requires too much effort, I would still keep it, with some additional
wording specifying it's partial and potentially inaccurate.

Such list could be an useful starting point for an integrator looking
for the correct driver for his/her SoC.

Cheers,

Paolo
  
Geert Uytterhoeven Oct. 24, 2023, 1:04 p.m. UTC | #3
Hi Paolo,

On Tue, Oct 24, 2023 at 12:54 PM Paolo Abeni <pabeni@redhat.com> wrote:
> On Sun, 2023-10-22 at 22:53 +0200, Wolfram Sang wrote:
> > Mentioning SoCs in Kconfig descriptions tends to get stale (e.g. RAVB is
> > missing RZV2M) or imprecise (e.g. SH_ETH is not available on all
> > R8A779x). Drop them instead of providing vague information. Improve the
> > file description a tad while here.
>
> It's not a big deal, but assuming that keeping the SoC list up2date
> requires too much effort, I would still keep it, with some additional
> wording specifying it's partial and potentially inaccurate.

Apparently it was too much effort...

> Such list could be an useful starting point for an integrator looking
> for the correct driver for his/her SoC.

For modern DT-based systems, it's much easier to look up compatible
values.

See also scripts/dtc/dt_to_config.

Gr{oetje,eeting}s,

                        Geert
  

Patch

diff --git a/drivers/net/ethernet/renesas/Kconfig b/drivers/net/ethernet/renesas/Kconfig
index 3ceb57408ed0..8ef5b0241e64 100644
--- a/drivers/net/ethernet/renesas/Kconfig
+++ b/drivers/net/ethernet/renesas/Kconfig
@@ -1,6 +1,6 @@ 
 # SPDX-License-Identifier: GPL-2.0
 #
-# Renesas device configuration
+# Renesas network device configuration
 #
 
 config NET_VENDOR_RENESAS
@@ -25,9 +25,6 @@  config SH_ETH
 	select PHYLIB
 	help
 	  Renesas SuperH Ethernet device driver.
-	  This driver supporting CPUs are:
-		- SH7619, SH7710, SH7712, SH7724, SH7734, SH7763, SH7757,
-		  R8A7740, R8A774x, R8A777x and R8A779x.
 
 config RAVB
 	tristate "Renesas Ethernet AVB support"
@@ -39,8 +36,6 @@  config RAVB
 	select PHYLIB
 	help
 	  Renesas Ethernet AVB device driver.
-	  This driver supports the following SoCs:
-		- R8A779x.
 
 config RENESAS_ETHER_SWITCH
 	tristate "Renesas Ethernet Switch support"
@@ -51,7 +46,5 @@  config RENESAS_ETHER_SWITCH
 	select PHYLINK
 	help
 	  Renesas Ethernet Switch device driver.
-	  This driver supports the following SoCs:
-		- R8A779Fx.
 
 endif # NET_VENDOR_RENESAS