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 6/6] timekeeping: fix kernel-doc mark issue on read_persistent_clock64
Date: Fri, 13 Nov 2020 15:24:35 +0800	[thread overview]
Message-ID: <1605252275-63652-6-git-send-email-alex.shi@linux.alibaba.com> (raw)
In-Reply-To: <1605252275-63652-1-git-send-email-alex.shi@linux.alibaba.com>

Fix the kernel-doc markup:
kernel/time/timekeeping.c:1563: warning: Function parameter or member
'wall_time' not described in 'read_persistent_wall_and_boot_offset'
kernel/time/timekeeping.c:1563: warning: Function parameter or member
'boot_offset' not described in 'read_persistent_wall_and_boot_offset'

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/timekeeping.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/kernel/time/timekeeping.c b/kernel/time/timekeeping.c
index 08ab749a76fc..665e820bb883 100644
--- a/kernel/time/timekeeping.c
+++ b/kernel/time/timekeeping.c
@@ -1556,8 +1556,9 @@ void __weak read_persistent_clock64(struct timespec64 *ts)
  *                                        from the boot.
  *
  * Weak dummy function for arches that do not yet support it.
- * wall_time	- current time as returned by persistent clock
- * boot_offset	- offset that is defined as wall_time - boot_time
+ * @wall_time:	- current time as returned by persistent clock
+ * @boot_offset: - offset that is defined as wall_time - boot_time
+ *
  * The default function calculates offset based on the current value of
  * local_clock(). This way architectures that support sched_clock() but don't
  * support dedicated boot time clock will provide the best estimate of the
-- 
2.29.GIT


  parent 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 [PATCH 1/6] time: fix kernel-doc markup Alex Shi
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 ` Alex Shi [this message]
2020-11-15 22:15   ` [PATCH 6/6] timekeeping: fix kernel-doc mark issue on read_persistent_clock64 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-6-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.