linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2] net: ethernet: xilinx: cleanup comments
@ 2022-02-17 16:05 trix
  2022-02-17 16:39 ` Randy Dunlap
  2022-02-18 11:50 ` patchwork-bot+netdevbpf
  0 siblings, 2 replies; 3+ messages in thread
From: trix @ 2022-02-17 16:05 UTC (permalink / raw)
  To: davem, kuba, michal.simek, radhey.shyam.pandey, rdunlap, esben,
	arnd, huangguangbin2, chenhao288, moyufeng, michael, yuehaibing,
	prabhakar.mahadev-lad.rj
  Cc: netdev, linux-arm-kernel, linux-kernel, Tom Rix

From: Tom Rix <trix@redhat.com>

Remove the second 'the'.
Replacements:
endiannes to endianness
areconnected to are connected
Mamagement to Management
undoccumented to undocumented
Xilink to Xilinx
strucutre to structure

Change kernel-doc comment style to c style for
/* Management ...

Signed-off-by: Tom Rix <trix@redhat.com>
Reviewed-by: Michal Simek <michal.simek@xilinx.com>
---
v2: Change the /** to /* 
    Add Michal's Reviewed-by: tag

 drivers/net/ethernet/xilinx/Kconfig               | 2 +-
 drivers/net/ethernet/xilinx/ll_temac.h            | 4 ++--
 drivers/net/ethernet/xilinx/ll_temac_main.c       | 2 +-
 drivers/net/ethernet/xilinx/xilinx_axienet_main.c | 2 +-
 drivers/net/ethernet/xilinx/xilinx_emaclite.c     | 2 +-
 5 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/drivers/net/ethernet/xilinx/Kconfig b/drivers/net/ethernet/xilinx/Kconfig
index 911b5ef9e680..0014729b8865 100644
--- a/drivers/net/ethernet/xilinx/Kconfig
+++ b/drivers/net/ethernet/xilinx/Kconfig
@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: GPL-2.0-only
 #
-# Xilink device configuration
+# Xilinx device configuration
 #
 
 config NET_VENDOR_XILINX
diff --git a/drivers/net/ethernet/xilinx/ll_temac.h b/drivers/net/ethernet/xilinx/ll_temac.h
index 4a73127e10a6..c6395c406418 100644
--- a/drivers/net/ethernet/xilinx/ll_temac.h
+++ b/drivers/net/ethernet/xilinx/ll_temac.h
@@ -271,7 +271,7 @@ This option defaults to enabled (set) */
 
 #define XTE_TIE_OFFSET			0x000003A4 /* Interrupt enable */
 
-/**  MII Mamagement Control register (MGTCR) */
+/* MII Management Control register (MGTCR) */
 #define XTE_MGTDR_OFFSET		0x000003B0 /* MII data */
 #define XTE_MIIMAI_OFFSET		0x000003B4 /* MII control */
 
@@ -283,7 +283,7 @@ This option defaults to enabled (set) */
 
 #define STS_CTRL_APP0_ERR         (1 << 31)
 #define STS_CTRL_APP0_IRQONEND    (1 << 30)
-/* undoccumented */
+/* undocumented */
 #define STS_CTRL_APP0_STOPONEND   (1 << 29)
 #define STS_CTRL_APP0_CMPLT       (1 << 28)
 #define STS_CTRL_APP0_SOP         (1 << 27)
diff --git a/drivers/net/ethernet/xilinx/ll_temac_main.c b/drivers/net/ethernet/xilinx/ll_temac_main.c
index b900ab5aef2a..7171b5cdec26 100644
--- a/drivers/net/ethernet/xilinx/ll_temac_main.c
+++ b/drivers/net/ethernet/xilinx/ll_temac_main.c
@@ -1008,7 +1008,7 @@ static void ll_temac_recv(struct net_device *ndev)
 		    (skb->len > 64)) {
 
 			/* Convert from device endianness (be32) to cpu
-			 * endiannes, and if necessary swap the bytes
+			 * endianness, and if necessary swap the bytes
 			 * (back) for proper IP checksum byte order
 			 * (be16).
 			 */
diff --git a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c
index de0a6372ae0e..6eeaab77fbe0 100644
--- a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c
+++ b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c
@@ -537,7 +537,7 @@ static int __axienet_device_reset(struct axienet_local *lp)
  * This function is called to reset and initialize the Axi Ethernet core. This
  * is typically called during initialization. It does a reset of the Axi DMA
  * Rx/Tx channels and initializes the Axi DMA BDs. Since Axi DMA reset lines
- * areconnected to Axi Ethernet reset lines, this in turn resets the Axi
+ * are connected to Axi Ethernet reset lines, this in turn resets the Axi
  * Ethernet core. No separate hardware reset is done for the Axi Ethernet
  * core.
  * Returns 0 on success or a negative error number otherwise.
diff --git a/drivers/net/ethernet/xilinx/xilinx_emaclite.c b/drivers/net/ethernet/xilinx/xilinx_emaclite.c
index 519599480b15..f65a638b7239 100644
--- a/drivers/net/ethernet/xilinx/xilinx_emaclite.c
+++ b/drivers/net/ethernet/xilinx/xilinx_emaclite.c
@@ -498,7 +498,7 @@ static void xemaclite_update_address(struct net_local *drvdata,
  * @dev:	Pointer to the network device instance
  * @address:	Void pointer to the sockaddr structure
  *
- * This function copies the HW address from the sockaddr strucutre to the
+ * This function copies the HW address from the sockaddr structure to the
  * net_device structure and updates the address in HW.
  *
  * Return:	Error if the net device is busy or 0 if the addr is set
-- 
2.26.3


^ permalink raw reply related	[flat|nested] 3+ messages in thread
* Re: [PATCH v2] net: ethernet: xilinx: cleanup comments
  2022-02-17 16:05 [PATCH v2] net: ethernet: xilinx: cleanup comments trix
@ 2022-02-17 16:39 ` Randy Dunlap
  2022-02-18 11:50 ` patchwork-bot+netdevbpf
  1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2022-02-17 16:39 UTC (permalink / raw)
  To: trix, davem, kuba, michal.simek, radhey.shyam.pandey, esben,
	arnd, huangguangbin2, chenhao288, moyufeng, michael, yuehaibing,
	prabhakar.mahadev-lad.rj
  Cc: netdev, linux-arm-kernel, linux-kernel



On 2/17/22 08:05, trix@redhat.com wrote:
> From: Tom Rix <trix@redhat.com>
> 
> Remove the second 'the'.
> Replacements:
> endiannes to endianness
> areconnected to are connected
> Mamagement to Management
> undoccumented to undocumented
> Xilink to Xilinx
> strucutre to structure
> 
> Change kernel-doc comment style to c style for
> /* Management ...
> 
> Signed-off-by: Tom Rix <trix@redhat.com>
> Reviewed-by: Michal Simek <michal.simek@xilinx.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>

thanks.

> ---
> v2: Change the /** to /* 
>     Add Michal's Reviewed-by: tag
> 
>  drivers/net/ethernet/xilinx/Kconfig               | 2 +-
>  drivers/net/ethernet/xilinx/ll_temac.h            | 4 ++--
>  drivers/net/ethernet/xilinx/ll_temac_main.c       | 2 +-
>  drivers/net/ethernet/xilinx/xilinx_axienet_main.c | 2 +-
>  drivers/net/ethernet/xilinx/xilinx_emaclite.c     | 2 +-
>  5 files changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/drivers/net/ethernet/xilinx/Kconfig b/drivers/net/ethernet/xilinx/Kconfig
> index 911b5ef9e680..0014729b8865 100644
> --- a/drivers/net/ethernet/xilinx/Kconfig
> +++ b/drivers/net/ethernet/xilinx/Kconfig
> @@ -1,6 +1,6 @@
>  # SPDX-License-Identifier: GPL-2.0-only
>  #
> -# Xilink device configuration
> +# Xilinx device configuration
>  #
>  
>  config NET_VENDOR_XILINX
> diff --git a/drivers/net/ethernet/xilinx/ll_temac.h b/drivers/net/ethernet/xilinx/ll_temac.h
> index 4a73127e10a6..c6395c406418 100644
> --- a/drivers/net/ethernet/xilinx/ll_temac.h
> +++ b/drivers/net/ethernet/xilinx/ll_temac.h
> @@ -271,7 +271,7 @@ This option defaults to enabled (set) */
>  
>  #define XTE_TIE_OFFSET			0x000003A4 /* Interrupt enable */
>  
> -/**  MII Mamagement Control register (MGTCR) */
> +/* MII Management Control register (MGTCR) */
>  #define XTE_MGTDR_OFFSET		0x000003B0 /* MII data */
>  #define XTE_MIIMAI_OFFSET		0x000003B4 /* MII control */
>  
> @@ -283,7 +283,7 @@ This option defaults to enabled (set) */
>  
>  #define STS_CTRL_APP0_ERR         (1 << 31)
>  #define STS_CTRL_APP0_IRQONEND    (1 << 30)
> -/* undoccumented */
> +/* undocumented */
>  #define STS_CTRL_APP0_STOPONEND   (1 << 29)
>  #define STS_CTRL_APP0_CMPLT       (1 << 28)
>  #define STS_CTRL_APP0_SOP         (1 << 27)
> diff --git a/drivers/net/ethernet/xilinx/ll_temac_main.c b/drivers/net/ethernet/xilinx/ll_temac_main.c
> index b900ab5aef2a..7171b5cdec26 100644
> --- a/drivers/net/ethernet/xilinx/ll_temac_main.c
> +++ b/drivers/net/ethernet/xilinx/ll_temac_main.c
> @@ -1008,7 +1008,7 @@ static void ll_temac_recv(struct net_device *ndev)
>  		    (skb->len > 64)) {
>  
>  			/* Convert from device endianness (be32) to cpu
> -			 * endiannes, and if necessary swap the bytes
> +			 * endianness, and if necessary swap the bytes
>  			 * (back) for proper IP checksum byte order
>  			 * (be16).
>  			 */
> diff --git a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c
> index de0a6372ae0e..6eeaab77fbe0 100644
> --- a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c
> +++ b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c
> @@ -537,7 +537,7 @@ static int __axienet_device_reset(struct axienet_local *lp)
>   * This function is called to reset and initialize the Axi Ethernet core. This
>   * is typically called during initialization. It does a reset of the Axi DMA
>   * Rx/Tx channels and initializes the Axi DMA BDs. Since Axi DMA reset lines
> - * areconnected to Axi Ethernet reset lines, this in turn resets the Axi
> + * are connected to Axi Ethernet reset lines, this in turn resets the Axi
>   * Ethernet core. No separate hardware reset is done for the Axi Ethernet
>   * core.
>   * Returns 0 on success or a negative error number otherwise.
> diff --git a/drivers/net/ethernet/xilinx/xilinx_emaclite.c b/drivers/net/ethernet/xilinx/xilinx_emaclite.c
> index 519599480b15..f65a638b7239 100644
> --- a/drivers/net/ethernet/xilinx/xilinx_emaclite.c
> +++ b/drivers/net/ethernet/xilinx/xilinx_emaclite.c
> @@ -498,7 +498,7 @@ static void xemaclite_update_address(struct net_local *drvdata,
>   * @dev:	Pointer to the network device instance
>   * @address:	Void pointer to the sockaddr structure
>   *
> - * This function copies the HW address from the sockaddr strucutre to the
> + * This function copies the HW address from the sockaddr structure to the
>   * net_device structure and updates the address in HW.
>   *
>   * Return:	Error if the net device is busy or 0 if the addr is set

-- 
~Randy

^ permalink raw reply	[flat|nested] 3+ messages in thread
* Re: [PATCH v2] net: ethernet: xilinx: cleanup comments
  2022-02-17 16:05 [PATCH v2] net: ethernet: xilinx: cleanup comments trix
  2022-02-17 16:39 ` Randy Dunlap
@ 2022-02-18 11:50 ` patchwork-bot+netdevbpf
  1 sibling, 0 replies; 3+ messages in thread
From: patchwork-bot+netdevbpf @ 2022-02-18 11:50 UTC (permalink / raw)
  To: Tom Rix
  Cc: davem, kuba, michal.simek, radhey.shyam.pandey, rdunlap, esben,
	arnd, huangguangbin2, chenhao288, moyufeng, michael, yuehaibing,
	prabhakar.mahadev-lad.rj, netdev, linux-arm-kernel, linux-kernel

Hello:

This patch was applied to netdev/net-next.git (master)
by David S. Miller <davem@davemloft.net>:

On Thu, 17 Feb 2022 08:05:18 -0800 you wrote:
> From: Tom Rix <trix@redhat.com>
> 
> Remove the second 'the'.
> Replacements:
> endiannes to endianness
> areconnected to are connected
> Mamagement to Management
> undoccumented to undocumented
> Xilink to Xilinx
> strucutre to structure
> 
> [...]

Here is the summary with links:
  - [v2] net: ethernet: xilinx: cleanup comments
    https://git.kernel.org/netdev/net-next/c/8aba73ef44eb

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html



^ permalink raw reply	[flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-02-18 11:50 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-02-17 16:05 [PATCH v2] net: ethernet: xilinx: cleanup comments trix
2022-02-17 16:39 ` Randy Dunlap
2022-02-18 11:50 ` patchwork-bot+netdevbpf

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).