All of lore.kernel.org
 help / color / mirror / Atom feed
From: Oliver O'Halloran <oohall@gmail.com>
To: linuxppc-dev@lists.ozlabs.org
Cc: Oliver O'Halloran <oohall@gmail.com>
Subject: [PATCH 4/6] powerpc/powernv: Fix spurious kerneldoc warnings in opal-prd.c
Date: Tue,  4 Aug 2020 10:54:08 +1000	[thread overview]
Message-ID: <20200804005410.146094-5-oohall@gmail.com> (raw)
In-Reply-To: <20200804005410.146094-1-oohall@gmail.com>

Comments opening with /** are parsed by kerneldoc and this causes the
following warning to be printed:

	arch/powerpc/platforms/powernv/opal-prd.c:31: warning: cannot understand
	function prototype: 'struct opal_prd_msg_queue_item '

opal_prd_mesg_queue_item is an internal data structure so there's no real
need for it to be documented at all. Fix up the comment to squash the
warning.

Signed-off-by: Oliver O'Halloran <oohall@gmail.com>
---
 arch/powerpc/platforms/powernv/opal-prd.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/powerpc/platforms/powernv/opal-prd.c b/arch/powerpc/platforms/powernv/opal-prd.c
index 45f4223a790f..deddaebf8c14 100644
--- a/arch/powerpc/platforms/powernv/opal-prd.c
+++ b/arch/powerpc/platforms/powernv/opal-prd.c
@@ -24,7 +24,7 @@
 #include <linux/uaccess.h>
 
 
-/**
+/*
  * The msg member must be at the end of the struct, as it's followed by the
  * message data.
  */
-- 
2.26.2


  parent reply	other threads:[~2020-08-04  1:05 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-04  0:54 Clean up W=1 for the powernv platform Oliver O'Halloran
2020-08-04  0:54 ` [PATCH 1/6] powerpc/powernv/smp: Fix spurious DBG() warning Oliver O'Halloran
2020-08-04  2:07   ` Joel Stanley
2020-08-04  6:58     ` Oliver O'Halloran
2020-08-04 12:05     ` Michael Ellerman
2020-09-09 13:37   ` Michael Ellerman
2020-08-04  0:54 ` [PATCH 2/6] powerpc/powernv: Include asm/powernv.h from the local powernv.h Oliver O'Halloran
2020-08-04  0:54 ` [PATCH 3/6] powerpc/powernv: Staticify functions without prototypes Oliver O'Halloran
2020-08-04  2:17   ` Joel Stanley
2020-08-04  0:54 ` Oliver O'Halloran [this message]
2020-08-04  2:18   ` [PATCH 4/6] powerpc/powernv: Fix spurious kerneldoc warnings in opal-prd.c Joel Stanley
2020-08-04  0:54 ` [PATCH 5/6] powerpc/powernv/pci: Drop unused parent variable Oliver O'Halloran
2020-08-04  2:19   ` Joel Stanley
2020-08-04  0:54 ` [PATCH 6/6] powerpc/nx: Don't pack struct coprocessor_request_block Oliver O'Halloran

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200804005410.146094-5-oohall@gmail.com \
    --to=oohall@gmail.com \
    --cc=linuxppc-dev@lists.ozlabs.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.