diff mbox series

devicetree: replace invalid kernel-doc comment headers

Message ID 20210322072343.19993-1-lukas.bulwahn@gmail.com (mailing list archive)
State New, archived
Headers show
Series devicetree: replace invalid kernel-doc comment headers | expand

Commit Message

Lukas Bulwahn March 22, 2021, 7:23 a.m. UTC
The opening comment mark '/**' is used for indicating the beginning of
kernel-doc comments.

Replace uses of '/**' for invalid cases in dt-binding headers and dts.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
Rob, please pick this quick kernel-doc cleanup patch.

 arch/arm64/boot/dts/hisilicon/hip05-d02.dts    | 2 +-
 arch/arm64/boot/dts/hisilicon/hip05.dtsi       | 2 +-
 arch/arm64/boot/dts/hisilicon/hip06-d03.dts    | 2 +-
 arch/arm64/boot/dts/hisilicon/hip06.dtsi       | 4 ++--
 arch/arm64/boot/dts/hisilicon/hip07-d05.dts    | 2 +-
 arch/arm64/boot/dts/hisilicon/hip07.dtsi       | 2 +-
 include/dt-bindings/reset/hisi,hi6220-resets.h | 2 +-
 include/dt-bindings/reset/snps,hsdk-reset.h    | 2 +-
 8 files changed, 9 insertions(+), 9 deletions(-)

Comments

Randy Dunlap March 22, 2021, 6:46 p.m. UTC | #1
On 3/22/21 12:23 AM, Lukas Bulwahn wrote:
> The opening comment mark '/**' is used for indicating the beginning of
> kernel-doc comments.
> 
> Replace uses of '/**' for invalid cases in dt-binding headers and dts.
> 
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>

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

Thanks.

> ---
> Rob, please pick this quick kernel-doc cleanup patch.
> 
>  arch/arm64/boot/dts/hisilicon/hip05-d02.dts    | 2 +-
>  arch/arm64/boot/dts/hisilicon/hip05.dtsi       | 2 +-
>  arch/arm64/boot/dts/hisilicon/hip06-d03.dts    | 2 +-
>  arch/arm64/boot/dts/hisilicon/hip06.dtsi       | 4 ++--
>  arch/arm64/boot/dts/hisilicon/hip07-d05.dts    | 2 +-
>  arch/arm64/boot/dts/hisilicon/hip07.dtsi       | 2 +-
>  include/dt-bindings/reset/hisi,hi6220-resets.h | 2 +-
>  include/dt-bindings/reset/snps,hsdk-reset.h    | 2 +-
>  8 files changed, 9 insertions(+), 9 deletions(-)
> 
> diff --git a/arch/arm64/boot/dts/hisilicon/hip05-d02.dts b/arch/arm64/boot/dts/hisilicon/hip05-d02.dts
> index 369b69b17b91..3d3d52bf41f5 100644
> --- a/arch/arm64/boot/dts/hisilicon/hip05-d02.dts
> +++ b/arch/arm64/boot/dts/hisilicon/hip05-d02.dts
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * dts file for Hisilicon D02 Development Board
>   *
>   * Copyright (C) 2014,2015 Hisilicon Ltd.
> diff --git a/arch/arm64/boot/dts/hisilicon/hip05.dtsi b/arch/arm64/boot/dts/hisilicon/hip05.dtsi
> index 4aed8d440b3a..5161e3476531 100644
> --- a/arch/arm64/boot/dts/hisilicon/hip05.dtsi
> +++ b/arch/arm64/boot/dts/hisilicon/hip05.dtsi
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * dts file for Hisilicon D02 Development Board
>   *
>   * Copyright (C) 2014,2015 Hisilicon Ltd.
> diff --git a/arch/arm64/boot/dts/hisilicon/hip06-d03.dts b/arch/arm64/boot/dts/hisilicon/hip06-d03.dts
> index 9f4a930e734d..97aa42a86fd9 100644
> --- a/arch/arm64/boot/dts/hisilicon/hip06-d03.dts
> +++ b/arch/arm64/boot/dts/hisilicon/hip06-d03.dts
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * dts file for Hisilicon D03 Development Board
>   *
>   * Copyright (C) 2016 Hisilicon Ltd.
> diff --git a/arch/arm64/boot/dts/hisilicon/hip06.dtsi b/arch/arm64/boot/dts/hisilicon/hip06.dtsi
> index 7deca5f763d5..d86ee1d25ab8 100644
> --- a/arch/arm64/boot/dts/hisilicon/hip06.dtsi
> +++ b/arch/arm64/boot/dts/hisilicon/hip06.dtsi
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * dts file for Hisilicon D03 Development Board
>   *
>   * Copyright (C) 2016 Hisilicon Ltd.
> @@ -315,7 +315,7 @@
>  		};
>  	};
>  
> -	/**
> +	/*
>  	 *  HiSilicon erratum 161010801: This describes the limitation
>  	 *  of HiSilicon platforms hip06/hip07 to support the SMMUv3
>  	 *  mappings for PCIe MSI transactions.
> diff --git a/arch/arm64/boot/dts/hisilicon/hip07-d05.dts b/arch/arm64/boot/dts/hisilicon/hip07-d05.dts
> index 81a2312c8a26..57debca7b1ac 100644
> --- a/arch/arm64/boot/dts/hisilicon/hip07-d05.dts
> +++ b/arch/arm64/boot/dts/hisilicon/hip07-d05.dts
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * dts file for Hisilicon D05 Development Board
>   *
>   * Copyright (C) 2016 Hisilicon Ltd.
> diff --git a/arch/arm64/boot/dts/hisilicon/hip07.dtsi b/arch/arm64/boot/dts/hisilicon/hip07.dtsi
> index 2172d8071181..553f7c5209ad 100644
> --- a/arch/arm64/boot/dts/hisilicon/hip07.dtsi
> +++ b/arch/arm64/boot/dts/hisilicon/hip07.dtsi
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * dts file for Hisilicon D05 Development Board
>   *
>   * Copyright (C) 2016 Hisilicon Ltd.
> diff --git a/include/dt-bindings/reset/hisi,hi6220-resets.h b/include/dt-bindings/reset/hisi,hi6220-resets.h
> index 63aff7d8aa45..c67f479eede7 100644
> --- a/include/dt-bindings/reset/hisi,hi6220-resets.h
> +++ b/include/dt-bindings/reset/hisi,hi6220-resets.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0 */
> -/**
> +/*
>   * This header provides index for the reset controller
>   * based on hi6220 SoC.
>   */
> diff --git a/include/dt-bindings/reset/snps,hsdk-reset.h b/include/dt-bindings/reset/snps,hsdk-reset.h
> index e1a643e4bc91..6a331c8d834d 100644
> --- a/include/dt-bindings/reset/snps,hsdk-reset.h
> +++ b/include/dt-bindings/reset/snps,hsdk-reset.h
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * This header provides index for the HSDK reset controller.
>   */
>  #ifndef _DT_BINDINGS_RESET_CONTROLLER_SNPS_HSDK
>
Rob Herring March 24, 2021, 7:59 p.m. UTC | #2
On Mon, Mar 22, 2021 at 08:23:43AM +0100, Lukas Bulwahn wrote:
> The opening comment mark '/**' is used for indicating the beginning of
> kernel-doc comments.
> 
> Replace uses of '/**' for invalid cases in dt-binding headers and dts.
> 
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> ---
> Rob, please pick this quick kernel-doc cleanup patch.

dts files don't go thru my tree. Please split this into 2 patches.

> 
>  arch/arm64/boot/dts/hisilicon/hip05-d02.dts    | 2 +-
>  arch/arm64/boot/dts/hisilicon/hip05.dtsi       | 2 +-
>  arch/arm64/boot/dts/hisilicon/hip06-d03.dts    | 2 +-
>  arch/arm64/boot/dts/hisilicon/hip06.dtsi       | 4 ++--
>  arch/arm64/boot/dts/hisilicon/hip07-d05.dts    | 2 +-
>  arch/arm64/boot/dts/hisilicon/hip07.dtsi       | 2 +-
>  include/dt-bindings/reset/hisi,hi6220-resets.h | 2 +-
>  include/dt-bindings/reset/snps,hsdk-reset.h    | 2 +-
>  8 files changed, 9 insertions(+), 9 deletions(-)
diff mbox series

Patch

diff --git a/arch/arm64/boot/dts/hisilicon/hip05-d02.dts b/arch/arm64/boot/dts/hisilicon/hip05-d02.dts
index 369b69b17b91..3d3d52bf41f5 100644
--- a/arch/arm64/boot/dts/hisilicon/hip05-d02.dts
+++ b/arch/arm64/boot/dts/hisilicon/hip05-d02.dts
@@ -1,5 +1,5 @@ 
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * dts file for Hisilicon D02 Development Board
  *
  * Copyright (C) 2014,2015 Hisilicon Ltd.
diff --git a/arch/arm64/boot/dts/hisilicon/hip05.dtsi b/arch/arm64/boot/dts/hisilicon/hip05.dtsi
index 4aed8d440b3a..5161e3476531 100644
--- a/arch/arm64/boot/dts/hisilicon/hip05.dtsi
+++ b/arch/arm64/boot/dts/hisilicon/hip05.dtsi
@@ -1,5 +1,5 @@ 
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * dts file for Hisilicon D02 Development Board
  *
  * Copyright (C) 2014,2015 Hisilicon Ltd.
diff --git a/arch/arm64/boot/dts/hisilicon/hip06-d03.dts b/arch/arm64/boot/dts/hisilicon/hip06-d03.dts
index 9f4a930e734d..97aa42a86fd9 100644
--- a/arch/arm64/boot/dts/hisilicon/hip06-d03.dts
+++ b/arch/arm64/boot/dts/hisilicon/hip06-d03.dts
@@ -1,5 +1,5 @@ 
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * dts file for Hisilicon D03 Development Board
  *
  * Copyright (C) 2016 Hisilicon Ltd.
diff --git a/arch/arm64/boot/dts/hisilicon/hip06.dtsi b/arch/arm64/boot/dts/hisilicon/hip06.dtsi
index 7deca5f763d5..d86ee1d25ab8 100644
--- a/arch/arm64/boot/dts/hisilicon/hip06.dtsi
+++ b/arch/arm64/boot/dts/hisilicon/hip06.dtsi
@@ -1,5 +1,5 @@ 
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * dts file for Hisilicon D03 Development Board
  *
  * Copyright (C) 2016 Hisilicon Ltd.
@@ -315,7 +315,7 @@ 
 		};
 	};
 
-	/**
+	/*
 	 *  HiSilicon erratum 161010801: This describes the limitation
 	 *  of HiSilicon platforms hip06/hip07 to support the SMMUv3
 	 *  mappings for PCIe MSI transactions.
diff --git a/arch/arm64/boot/dts/hisilicon/hip07-d05.dts b/arch/arm64/boot/dts/hisilicon/hip07-d05.dts
index 81a2312c8a26..57debca7b1ac 100644
--- a/arch/arm64/boot/dts/hisilicon/hip07-d05.dts
+++ b/arch/arm64/boot/dts/hisilicon/hip07-d05.dts
@@ -1,5 +1,5 @@ 
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * dts file for Hisilicon D05 Development Board
  *
  * Copyright (C) 2016 Hisilicon Ltd.
diff --git a/arch/arm64/boot/dts/hisilicon/hip07.dtsi b/arch/arm64/boot/dts/hisilicon/hip07.dtsi
index 2172d8071181..553f7c5209ad 100644
--- a/arch/arm64/boot/dts/hisilicon/hip07.dtsi
+++ b/arch/arm64/boot/dts/hisilicon/hip07.dtsi
@@ -1,5 +1,5 @@ 
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * dts file for Hisilicon D05 Development Board
  *
  * Copyright (C) 2016 Hisilicon Ltd.
diff --git a/include/dt-bindings/reset/hisi,hi6220-resets.h b/include/dt-bindings/reset/hisi,hi6220-resets.h
index 63aff7d8aa45..c67f479eede7 100644
--- a/include/dt-bindings/reset/hisi,hi6220-resets.h
+++ b/include/dt-bindings/reset/hisi,hi6220-resets.h
@@ -1,5 +1,5 @@ 
 /* SPDX-License-Identifier: GPL-2.0 */
-/**
+/*
  * This header provides index for the reset controller
  * based on hi6220 SoC.
  */
diff --git a/include/dt-bindings/reset/snps,hsdk-reset.h b/include/dt-bindings/reset/snps,hsdk-reset.h
index e1a643e4bc91..6a331c8d834d 100644
--- a/include/dt-bindings/reset/snps,hsdk-reset.h
+++ b/include/dt-bindings/reset/snps,hsdk-reset.h
@@ -1,4 +1,4 @@ 
-/**
+/*
  * This header provides index for the HSDK reset controller.
  */
 #ifndef _DT_BINDINGS_RESET_CONTROLLER_SNPS_HSDK