All of lore.kernel.org
 help / color / mirror / Atom feed
From: "tip-bot2 for Alex Shi" <tip-bot2@linutronix.de>
To: linux-tip-commits@vger.kernel.org
Cc: Alex Shi <alex.shi@linux.alibaba.com>,
	Thomas Gleixner <tglx@linutronix.de>,
	x86@kernel.org, linux-kernel@vger.kernel.org
Subject: [tip: timers/core] timekeeping: Add missing parameter docs for pvclock_gtod_[un]register_notifier()
Date: Sun, 15 Nov 2020 22:51:04 -0000	[thread overview]
Message-ID: <160548066443.11244.2312343456989921633.tip-bot2@tip-bot2> (raw)
In-Reply-To: <1605252275-63652-3-git-send-email-alex.shi@linux.alibaba.com>

The following commit has been merged into the timers/core branch of tip:

Commit-ID:     f27f7c3f100e74a7f451a63a15788f50c52f7cce
Gitweb:        https://git.kernel.org/tip/f27f7c3f100e74a7f451a63a15788f50c52f7cce
Author:        Alex Shi <alex.shi@linux.alibaba.com>
AuthorDate:    Fri, 13 Nov 2020 15:24:32 +08:00
Committer:     Thomas Gleixner <tglx@linutronix.de>
CommitterDate: Sun, 15 Nov 2020 23:47:24 +01:00

timekeeping: Add missing parameter docs for pvclock_gtod_[un]register_notifier()

The kernel-doc parser complains about:
 kernel/time/timekeeping.c:651: warning: Function parameter or member
 'nb' not described in 'pvclock_gtod_register_notifier'
 kernel/time/timekeeping.c:670: warning: Function parameter or member
 'nb' not described in 'pvclock_gtod_unregister_notifier'

Add the missing parameter explanations.

[ tglx: Massaged changelog ]

Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/1605252275-63652-3-git-send-email-alex.shi@linux.alibaba.com

---
 kernel/time/timekeeping.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/kernel/time/timekeeping.c b/kernel/time/timekeeping.c
index ab4b831..9c93923 100644
--- a/kernel/time/timekeeping.c
+++ b/kernel/time/timekeeping.c
@@ -663,6 +663,7 @@ static void update_pvclock_gtod(struct timekeeper *tk, bool was_set)
 
 /**
  * pvclock_gtod_register_notifier - register a pvclock timedata update listener
+ * @nb: Pointer to the notifier block to register
  */
 int pvclock_gtod_register_notifier(struct notifier_block *nb)
 {
@@ -682,6 +683,7 @@ EXPORT_SYMBOL_GPL(pvclock_gtod_register_notifier);
 /**
  * pvclock_gtod_unregister_notifier - unregister a pvclock
  * timedata update listener
+ * @nb: Pointer to the notifier block to unregister
  */
 int pvclock_gtod_unregister_notifier(struct notifier_block *nb)
 {

  parent reply	other threads:[~2020-11-15 22:51 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-bot2 for Alex Shi [this message]
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=160548066443.11244.2312343456989921633.tip-bot2@tip-bot2 \
    --to=tip-bot2@linutronix.de \
    --cc=alex.shi@linux.alibaba.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-tip-commits@vger.kernel.org \
    --cc=tglx@linutronix.de \
    --cc=x86@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 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.