[PATCH net-next] net: stmicro: dwmac4 comments enhancement

[PATCH net-next] net: stmicro: dwmac4 comments enhancement

[Joao Pinto]

This patch adds clarification about the HW Controller that the dwmac4 driver
package is targeting.

Signed-off-by: Joao Pinto <jpinto@synopsys.com>
---
 drivers/net/ethernet/stmicro/stmmac/dwmac4_core.c  | 4 ++--
 drivers/net/ethernet/stmicro/stmmac/dwmac4_descs.c | 4 ++--
 drivers/net/ethernet/stmicro/stmmac/dwmac4_descs.h | 2 +-
 drivers/net/ethernet/stmicro/stmmac/dwmac4_dma.c   | 4 ++--
 4 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/drivers/net/ethernet/stmicro/stmmac/dwmac4_core.c b/drivers/net/ethernet/stmicro/stmmac/dwmac4_core.c
index 202216c..d893da9 100644
--- a/drivers/net/ethernet/stmicro/stmmac/dwmac4_core.c
+++ b/drivers/net/ethernet/stmicro/stmmac/dwmac4_core.c
@@ -1,6 +1,6 @@
 /*
- * This is the driver for the GMAC on-chip Ethernet controller for ST SoCs.
- * DWC Ether MAC version 4.00  has been used for developing this code.
+ * This is the driver for the DesignWare Ethernet QoS Controller.
+ * For historical reasons it started in 4.x version.
  *
  * This only implements the mac core functions for this chip.
  *
diff --git a/drivers/net/ethernet/stmicro/stmmac/dwmac4_descs.c b/drivers/net/ethernet/stmicro/stmmac/dwmac4_descs.c
index 8816515..1f94bd6 100644
--- a/drivers/net/ethernet/stmicro/stmmac/dwmac4_descs.c
+++ b/drivers/net/ethernet/stmicro/stmmac/dwmac4_descs.c
@@ -1,6 +1,6 @@
 /*
- * This contains the functions to handle the descriptors for DesignWare databook
- * 4.xx.
+ * This contains the functions to handle the descriptors for the DesignWare
+ * Ethernet QoS Controller. For historical reasons it started in 4.x version.
  *
  * Copyright (C) 2015  STMicroelectronics Ltd
  *
diff --git a/drivers/net/ethernet/stmicro/stmmac/dwmac4_descs.h b/drivers/net/ethernet/stmicro/stmmac/dwmac4_descs.h
index 9736c50..cfeb08a 100644
--- a/drivers/net/ethernet/stmicro/stmmac/dwmac4_descs.h
+++ b/drivers/net/ethernet/stmicro/stmmac/dwmac4_descs.h
@@ -1,6 +1,6 @@
 /*
  * Header File to describe the DMA descriptors and related definitions specific
- * for DesignWare databook 4.xx.
+ * for the DesignWare Ethernet QoS Controller
  *
  * Copyright (C) 2015  STMicroelectronics Ltd
  *
diff --git a/drivers/net/ethernet/stmicro/stmmac/dwmac4_dma.c b/drivers/net/ethernet/stmicro/stmmac/dwmac4_dma.c
index 377d1b4..301d01f 100644
--- a/drivers/net/ethernet/stmicro/stmmac/dwmac4_dma.c
+++ b/drivers/net/ethernet/stmicro/stmmac/dwmac4_dma.c
@@ -1,6 +1,6 @@
 /*
- * This is the driver for the GMAC on-chip Ethernet controller for ST SoCs.
- * DWC Ether MAC version 4.xx  has been used for  developing this code.
+ * This is the driver for DesignWare Ethernet QoS Controller.
+ * For historical reasons it started in 4.x version.
  *
  * This contains the functions to handle the dma.
  *
-- 
2.9.3

Re: [PATCH net-next] net: stmicro: dwmac4 comments enhancement

[David Miller]

From: Joao Pinto <Joao.Pinto@synopsys.com>
Date: Mon, 23 Jan 2017 15:56:24 +0000

> + * This is the driver for the DesignWare Ethernet QoS Controller.

This is fine.

> + * For historical reasons it started in 4.x version.

This provides no value whatsoever.

Please resist the urge to fidget and adjust random things, just get to
the point and make the minimum change necessary to achieve a specific,
well defined, constrained, objective.

Please!

I'm really getting irritated with how much effort is being expended
to make dilly-dally style changes that provide little or no value
to the driver.

Fix bugs and contribute new support for new chips, because this stuff
I'm seeing here is just eating up everyone's time rather than improving
the driver.

Thank you.