linux-gpio.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
	Linus Walleij <linus.walleij@linaro.org>,
	Bartosz Golaszewski <brgl@bgdev.pl>,
	linux-gpio@vger.kernel.org
Subject: [PATCH] gpio/consumer.h: don't use "/**" for non-kernel-doc comments
Date: Sat, 29 Jan 2022 23:31:03 -0800	[thread overview]
Message-ID: <20220130073103.26792-1-rdunlap@infradead.org> (raw)

Use "/*" to begin non-kernel-doc comments instead of "/**",
which indicates the beginning of kernel-doc notation.

Quietens these kernel-doc warnings:

consumer.h:13: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Opaque descriptor for a GPIO. These are obtained using gpiod_get() and are
consumer.h:13: warning: missing initial short description on line:
 * Opaque descriptor for a GPIO. These are obtained using gpiod_get() and are
consumer.h:22: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Opaque descriptor for a structure of GPIO array attributes.  This structure
consumer.h:22: warning: missing initial short description on line:
 * Opaque descriptor for a structure of GPIO array attributes.  This structure
consumer.h:30: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Struct containing an array of descriptors that can be obtained using
consumer.h:30: warning: missing initial short description on line:
 * Struct containing an array of descriptors that can be obtained using
consumer.h:46: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Optional flags that can be passed to one of gpiod_* to configure direction
consumer.h:46: warning: missing initial short description on line:
 * Optional flags that can be passed to one of gpiod_* to configure direction

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Bartosz Golaszewski <brgl@bgdev.pl>
Cc: linux-gpio@vger.kernel.org
---
 include/linux/gpio/consumer.h |    8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

--- linux-next-20220128.orig/include/linux/gpio/consumer.h
+++ linux-next-20220128/include/linux/gpio/consumer.h
@@ -9,7 +9,7 @@
 
 struct device;
 
-/**
+/*
  * Opaque descriptor for a GPIO. These are obtained using gpiod_get() and are
  * preferable to the old integer-based handles.
  *
@@ -18,7 +18,7 @@ struct device;
  */
 struct gpio_desc;
 
-/**
+/*
  * Opaque descriptor for a structure of GPIO array attributes.  This structure
  * is attached to struct gpiod_descs obtained from gpiod_get_array() and can be
  * passed back to get/set array functions in order to activate fast processing
@@ -26,7 +26,7 @@ struct gpio_desc;
  */
 struct gpio_array;
 
-/**
+/*
  * Struct containing an array of descriptors that can be obtained using
  * gpiod_get_array().
  */
@@ -42,7 +42,7 @@ struct gpio_descs {
 #define GPIOD_FLAGS_BIT_OPEN_DRAIN	BIT(3)
 #define GPIOD_FLAGS_BIT_NONEXCLUSIVE	BIT(4)
 
-/**
+/*
  * Optional flags that can be passed to one of gpiod_* to configure direction
  * and output value. These values cannot be OR'd.
  */

             reply	other threads:[~2022-01-30  7:31 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-30  7:31 Randy Dunlap [this message]
2022-01-31 11:24 ` [PATCH] gpio/consumer.h: don't use "/**" for non-kernel-doc comments Linus Walleij
2022-02-01  3:52   ` Randy Dunlap

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=20220130073103.26792-1-rdunlap@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=brgl@bgdev.pl \
    --cc=linus.walleij@linaro.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).