All of lore.kernel.org
 help / color / mirror / Atom feed
From: Alex Shi <alex.shi@linux.alibaba.com>
To: john.stultz@linaro.org
Cc: Thomas Gleixner <tglx@linutronix.de>,
	Stephen Boyd <sboyd@kernel.org>,
	linux-kernel@vger.kernel.org
Subject: [PATCH 1/6] time: fix kernel-doc markup
Date: Fri, 13 Nov 2020 15:24:30 +0800	[thread overview]
Message-ID: <1605252275-63652-1-git-send-email-alex.shi@linux.alibaba.com> (raw)

The kernel-doc interface error cause some warning:
kernel/time/timeconv.c:79: warning: Function parameter or member
'totalsecs' not described in 'time64_to_tm'
kernel/time/timeconv.c:79: warning: Function parameter or member
'offset' not described in 'time64_to_tm'
kernel/time/timeconv.c:79: warning: Function parameter or member
'result' not described in 'time64_to_tm'

Fix them.

Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: John Stultz <john.stultz@linaro.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Stephen Boyd <sboyd@kernel.org>
Cc: linux-kernel@vger.kernel.org
---
 kernel/time/timeconv.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/kernel/time/timeconv.c b/kernel/time/timeconv.c
index 589e0a552129..62e3b46717a6 100644
--- a/kernel/time/timeconv.c
+++ b/kernel/time/timeconv.c
@@ -70,10 +70,10 @@ static const unsigned short __mon_yday[2][13] = {
 /**
  * time64_to_tm - converts the calendar time to local broken-down time
  *
- * @totalsecs	the number of seconds elapsed since 00:00:00 on January 1, 1970,
+ * @totalsecs:	the number of seconds elapsed since 00:00:00 on January 1, 1970,
  *		Coordinated Universal Time (UTC).
- * @offset	offset seconds adding to totalsecs.
- * @result	pointer to struct tm variable to receive broken-down time
+ * @offset:	offset seconds adding to totalsecs.
+ * @result:	pointer to struct tm variable to receive broken-down time
  */
 void time64_to_tm(time64_t totalsecs, int offset, struct tm *result)
 {
-- 
2.29.GIT


             reply	other threads:[~2020-11-13  7:24 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-13  7:24 Alex Shi [this message]
2020-11-13  7:24 ` [PATCH 2/6] timekeeping: add missed kernel-doc marks for 'tkf' Alex Shi
2020-11-15 20:08   ` Thomas Gleixner
2020-11-15 22:51   ` [tip: timers/core] timekeeping: Add missing parameter documentation for update_fast_timekeeper() tip-bot2 for Alex Shi
2020-11-13  7:24 ` [PATCH 3/6] timekeeping: add kernel-doc markup for pvclock notifier Alex Shi
2020-11-15 22:28   ` Thomas Gleixner
2020-11-15 22:51   ` [tip: timers/core] timekeeping: Add missing parameter docs for pvclock_gtod_[un]register_notifier() tip-bot2 for Alex Shi
2020-11-13  7:24 ` [PATCH 4/6] timekeeping: remove static functions from kernel-doc markup Alex Shi
2020-11-15 22:51   ` [tip: timers/core] timekeeping: Remove " tip-bot2 for Alex Shi
2020-11-13  7:24 ` [PATCH 5/6] timekeeping: add ts/tk explaination for kernel-doc Alex Shi
2020-11-15 22:19   ` Thomas Gleixner
2020-11-15 22:51   ` [tip: timers/core] timekeeping: Address parameter documentation issues for various functions tip-bot2 for Alex Shi
2020-11-13  7:24 ` [PATCH 6/6] timekeeping: fix kernel-doc mark issue on read_persistent_clock64 Alex Shi
2020-11-15 22:15   ` Thomas Gleixner
2020-11-15 22:51   ` [tip: timers/core] timekeeping: Fix parameter docs of read_persistent_wall_and_boot_offset() tip-bot2 for Alex Shi
2020-11-15 22:48 ` [PATCH 1/6] time: fix kernel-doc markup Thomas Gleixner
2020-11-16  2:44   ` Alex Shi
2020-11-15 22:51 ` [tip: timers/core] time: Add missing colons for parameter documentation of time64_to_tm() tip-bot2 for Alex Shi

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=1605252275-63652-1-git-send-email-alex.shi@linux.alibaba.com \
    --to=alex.shi@linux.alibaba.com \
    --cc=john.stultz@linaro.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=sboyd@kernel.org \
    --cc=tglx@linutronix.de \
    /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.