public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Yijing Wang <wangyijing@huawei.com>
To: Thomas Gleixner <tglx@linutronix.de>
Cc: John Stultz <john.stultz@linaro.org>,
	<linux-kernel@vger.kernel.org>, Hanjun Guo <guohanjun@huawei.com>
Subject: Re: [PATCH] clocksource: fix some comments typo in clocksource.c
Date: Thu, 23 Jan 2014 09:15:22 +0800	[thread overview]
Message-ID: <52E06D2A.30509@huawei.com> (raw)
In-Reply-To: <alpine.DEB.2.02.1401222201260.24986@ionos.tec.linutronix.de>

On 2014/1/23 5:05, Thomas Gleixner wrote:
> On Thu, 2 Jan 2014, Yijing Wang wrote:
> 
>> Fix some trivial comments typo in kernel/time/clocksource.c
> 
> That's not a typo. Thats a left over. The function simply cannot fail
> anymore. So the subject of that patch should be something like:
> 
> clocksource: Remove outdated comments

Hi Thomas, sorry for my poor English, I will update this patch title and changelog.

> 
> And the changelog should explain, that the functions always return 0,
> so the comment is just pointless. A nice follow up on that would be to
> actually make the function void instead of returning a pointless int,
> but that requires to check all call sites.

You are right, it's pointless to return 0, I will try to change the function type to void
in a separate patch, thanks!

>  
>> Signed-off-by: Yijing Wang <wangyijing@huawei.com>
>> ---
>>  kernel/time/clocksource.c |    3 ---
>>  1 files changed, 0 insertions(+), 3 deletions(-)
>>
>> diff --git a/kernel/time/clocksource.c b/kernel/time/clocksource.c
>> index ba3e502..9951575 100644
>> --- a/kernel/time/clocksource.c
>> +++ b/kernel/time/clocksource.c
>> @@ -779,8 +779,6 @@ EXPORT_SYMBOL_GPL(__clocksource_updatefreq_scale);
>>   * @scale:	Scale factor multiplied against freq to get clocksource hz
>>   * @freq:	clocksource frequency (cycles per second) divided by scale
>>   *
>> - * Returns -EBUSY if registration fails, zero otherwise.
>> - *
>>   * This *SHOULD NOT* be called directly! Please use the
>>   * clocksource_register_hz() or clocksource_register_khz helper functions.
>>   */
>> @@ -805,7 +803,6 @@ EXPORT_SYMBOL_GPL(__clocksource_register_scale);
>>   * clocksource_register - Used to install new clocksources
>>   * @cs:		clocksource to be registered
>>   *
>> - * Returns -EBUSY if registration fails, zero otherwise.
>>   */
>>  int clocksource_register(struct clocksource *cs)
>>  {
>> -- 
>> 1.7.1
>>
>>
>>
> 
> 


-- 
Thanks!
Yijing


      reply	other threads:[~2014-01-23  1:15 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-01-02  8:56 [PATCH] clocksource: fix some comments typo in clocksource.c Yijing Wang
2014-01-22 21:05 ` Thomas Gleixner
2014-01-23  1:15   ` Yijing Wang [this message]

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=52E06D2A.30509@huawei.com \
    --to=wangyijing@huawei.com \
    --cc=guohanjun@huawei.com \
    --cc=john.stultz@linaro.org \
    --cc=linux-kernel@vger.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox