All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Stuart Yoder <stuyoder@gmail.com>,
	Laurentiu Tudor <laurentiu.tudor@nxp.com>
Subject: [PATCH 01/10] bus: fsl-mc: mc-io: Supply function names for 'fsl_create_mc_io()' and 'fsl_destroy_mc_io()'
Date: Wed, 26 May 2021 09:10:29 +0100	[thread overview]
Message-ID: <20210526081038.544942-2-lee.jones@linaro.org> (raw)
In-Reply-To: <20210526081038.544942-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 drivers/bus/fsl-mc/mc-io.c:53: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/bus/fsl-mc/mc-io.c:126: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Cc: Stuart Yoder <stuyoder@gmail.com>
Cc: Laurentiu Tudor <laurentiu.tudor@nxp.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/bus/fsl-mc/mc-io.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/bus/fsl-mc/mc-io.c b/drivers/bus/fsl-mc/mc-io.c
index 305015486b91c..9af6b05b89d6f 100644
--- a/drivers/bus/fsl-mc/mc-io.c
+++ b/drivers/bus/fsl-mc/mc-io.c
@@ -50,7 +50,7 @@ static void fsl_mc_io_unset_dpmcp(struct fsl_mc_io *mc_io)
 }
 
 /**
- * Creates an MC I/O object
+ * fsl_create_mc_io() - Creates an MC I/O object
  *
  * @dev: device to be associated with the MC I/O object
  * @mc_portal_phys_addr: physical address of the MC portal to use
@@ -123,7 +123,7 @@ int __must_check fsl_create_mc_io(struct device *dev,
 }
 
 /**
- * Destroys an MC I/O object
+ * fsl_destroy_mc_io() - Destroys an MC I/O object
  *
  * @mc_io: MC I/O object to destroy
  */
-- 
2.31.1


  reply	other threads:[~2021-05-26  8:10 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-26  8:10 [PATCH 00/10] Rid W=1 warnings from Bus Lee Jones
2021-05-26  8:10 ` Lee Jones [this message]
2021-05-26  8:10 ` [PATCH 02/10] bus: fsl-mc: mc-sys: Supply missing function names in kernel-doc headers Lee Jones
2021-05-26  8:10 ` [PATCH 03/10] bus: fsl-mc: fsl-mc-bus: Demote a bunch of non-conformant kernel-doc headers and help others Lee Jones
2021-05-26  8:10 ` [PATCH 04/10] bus: fsl-mc: dprc: Fix a couple of misspelling and formatting issues Lee Jones
2021-05-26  8:10 ` [PATCH 05/10] bus: fsl-mc: dprc-driver: Fix some missing/incorrect function parameter descriptions Lee Jones
2021-05-26  8:10 ` [PATCH 06/10] bus: fsl-mc: fsl-mc-allocator: Fix misspelling of 'new_mc_adev' and demote non-kernel-doc headers Lee Jones
2021-05-26  8:10 ` [PATCH 07/10] bus: qcom-ebi2: Fix incorrect documentation for '{slow,fast}_cfg' Lee Jones
2021-05-26 22:33   ` Linus Walleij
2021-05-27  2:22   ` Bjorn Andersson
2021-05-26  8:10 ` [PATCH 08/10] bus: fsl-mc-msi: Fix a little doc-rot pertaining to 'np' to 'fwnode' conversion Lee Jones
2021-05-26  8:10 ` [PATCH 09/10] bus: ti-sysc: Correct misdocumentation of 'sysc_ioremap()' Lee Jones
2021-06-11  7:21   ` Tony Lindgren
2021-05-26  8:10 ` [PATCH 10/10] bus: fsl-mc: mc-io: Correct misdocumentation of 'dpmcp_dev' param Lee Jones
2021-05-26 12:19 ` [PATCH 00/10] Rid W=1 warnings from Bus Laurentiu Tudor
2021-06-17  9:49   ` Lee Jones
2021-06-17 10:11     ` Laurentiu Tudor
2021-06-17 10:57       ` Greg KH

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=20210526081038.544942-2-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=laurentiu.tudor@nxp.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=stuyoder@gmail.com \
    /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.