From: Thomas Gleixner <tglx@linutronix.de>
To: Alex Shi <alex.shi@linux.alibaba.com>, john.stultz@linaro.org
Cc: Stephen Boyd <sboyd@kernel.org>, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 3/6] timekeeping: add kernel-doc markup for pvclock notifier
Date: Sun, 15 Nov 2020 23:28:10 +0100 [thread overview]
Message-ID: <87zh3i45mt.fsf@nanos.tec.linutronix.de> (raw)
In-Reply-To: <1605252275-63652-3-git-send-email-alex.shi@linux.alibaba.com>
On Fri, Nov 13 2020 at 15:24, Alex Shi wrote:
> /**
> * pvclock_gtod_register_notifier - register a pvclock timedata update listener
> + * @nb: a notifier entry which register on pvclock_gtod_chain.
What is a notifier entry? The struct is named notifier_block and the
argument is a pointer to a notifier block. So why making things up?
Also it's completely irrelevant for the reader to know about the name of
the notifier chain. The function documentation says:
register a pvclock timedata update listener
which precisely describes what the function does. pvclock_gtod_chain is
an internal implementation detail and nothing external can depend on it.
It could be renamed to 'foo_bar' and the function would still do the
same thing.
* @nb: Notifier block to register
is precise and good enough, isn't it?
Thanks,
tglx
next prev parent reply other threads:[~2020-11-15 22:28 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 [this message]
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=87zh3i45mt.fsf@nanos.tec.linutronix.de \
--to=tglx@linutronix.de \
--cc=alex.shi@linux.alibaba.com \
--cc=john.stultz@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=sboyd@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