diff mbox series

powerpc/pseries: PLPKS: undo kernel-doc comment notation

Message ID 20230810000740.23756-1-rdunlap@infradead.org
State New
Headers
Series powerpc/pseries: PLPKS: undo kernel-doc comment notation |

Commit Message

Randy Dunlap Aug. 10, 2023, 12:07 a.m. UTC 
  Don't use kernel-doc "/**" comment format for non-kernel-doc comments.
This prevents a kernel-doc warning:

  arch/powerpc/platforms/pseries/plpks.c:186: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
  * Label is combination of label attributes + name.

Fixes: 2454a7af0f2a ("powerpc/pseries: define driver for Platform KeyStore")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Link: lore.kernel.org/r/202308040430.GxmPAnwZ-lkp@intel.com
Cc: Nayna Jain <nayna@linux.ibm.com>
Cc: Michael Ellerman <mpe@ellerman.id.au>
Cc: linuxppc-dev@lists.ozlabs.org
---
 arch/powerpc/platforms/pseries/plpks.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Michael Ellerman Aug. 23, 2023, 11:55 a.m. UTC | #1 
On Wed, 09 Aug 2023 17:07:40 -0700, Randy Dunlap wrote:
> Don't use kernel-doc "/**" comment format for non-kernel-doc comments.
> This prevents a kernel-doc warning:
> 
>   arch/powerpc/platforms/pseries/plpks.c:186: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>   * Label is combination of label attributes + name.
> 
> 
> [...]

Applied to powerpc/next.

[1/1] powerpc/pseries: PLPKS: undo kernel-doc comment notation
      https://git.kernel.org/powerpc/c/506e550a7da9e995bea3bd585db591068f98b2bf

cheers
diff mbox series

Patch

diff -- a/arch/powerpc/platforms/pseries/plpks.c b/arch/powerpc/platforms/pseries/plpks.c
--- a/arch/powerpc/platforms/pseries/plpks.c
+++ b/arch/powerpc/platforms/pseries/plpks.c
@@ -194,7 +194,7 @@  static struct plpks_auth *construct_auth
 	return auth;
 }
 
-/**
+/*
  * Label is combination of label attributes + name.
  * Label attributes are used internally by kernel and not exposed to the user.
  */