linux-kernel - Re: [PATCH v2] net: ethernet: xilinx: cleanup comments

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 for Android: free password hash cracker in your pocket
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <a9c40409-a72d-276c-777f-c7b1863e4537@infradead.org>
Date:   Thu, 17 Feb 2022 08:39:41 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     trix@...hat.com, davem@...emloft.net, kuba@...nel.org,
        michal.simek@...inx.com, radhey.shyam.pandey@...inx.com,
        esben@...nix.com, arnd@...db.de, huangguangbin2@...wei.com,
        chenhao288@...ilicon.com, moyufeng@...wei.com, michael@...le.cc,
        yuehaibing@...wei.com, prabhakar.mahadev-lad.rj@...renesas.com
Cc:     netdev@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] net: ethernet: xilinx: cleanup comments



On 2/17/22 08:05, trix@...hat.com wrote:
> From: Tom Rix <trix@...hat.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@...hat.com>
> Reviewed-by: Michal Simek <michal.simek@...inx.com>

Acked-by: Randy Dunlap <rdunlap@...radead.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