From: Enric Balletbo i Serra <enric.balletbo@collabora.com>
To: linux-kernel@vger.kernel.org
Cc: Collabora Kernel ML <kernel@collabora.com>,
groeck@chromium.org, bleung@chromium.org, dtor@chromium.org,
Tim Wawrzynczak <twawrzynczak@chromium.org>
Subject: [PATCH 2/3] platform/chrome: cros_ec_debugfs: Fix kernel-doc comment first line
Date: Fri, 14 Jun 2019 13:15:50 +0200 [thread overview]
Message-ID: <20190614111551.28686-2-enric.balletbo@collabora.com> (raw)
In-Reply-To: <20190614111551.28686-1-enric.balletbo@collabora.com>
kernel-doc comments have a prescribed format. To be _particularly_
correct we should also capitalise the brief description and terminate
it with a period.
Signed-off-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
---
drivers/platform/chrome/cros_ec_debugfs.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/drivers/platform/chrome/cros_ec_debugfs.c b/drivers/platform/chrome/cros_ec_debugfs.c
index 970ba13df9a1..cd3fb9c22a44 100644
--- a/drivers/platform/chrome/cros_ec_debugfs.c
+++ b/drivers/platform/chrome/cros_ec_debugfs.c
@@ -25,7 +25,8 @@
#define CIRC_ADD(idx, size, value) (((idx) + (value)) & ((size) - 1))
-/* struct cros_ec_debugfs - ChromeOS EC debugging information
+/**
+ * struct cros_ec_debugfs - EC debugging information.
*
* @ec: EC device this debugfs information belongs to
* @dir: dentry for debugfs files
--
2.20.1
next prev parent reply other threads:[~2019-06-14 11:16 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-14 11:15 [PATCH 1/3] platform/chrome: cros_ec_debugfs: Add debugfs entry to retrieve EC uptime Enric Balletbo i Serra
2019-06-14 11:15 ` Enric Balletbo i Serra [this message]
2019-06-14 11:15 ` [PATCH 3/3] platform/chrome: cros_ec_debugfs: Add debugfs ABI documentation Enric Balletbo i Serra
2019-06-18 8:45 ` [PATCH 1/3] platform/chrome: cros_ec_debugfs: Add debugfs entry to retrieve EC uptime Enric Balletbo i Serra
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=20190614111551.28686-2-enric.balletbo@collabora.com \
--to=enric.balletbo@collabora.com \
--cc=bleung@chromium.org \
--cc=dtor@chromium.org \
--cc=groeck@chromium.org \
--cc=kernel@collabora.com \
--cc=linux-kernel@vger.kernel.org \
--cc=twawrzynczak@chromium.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).