From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751904Ab1LSJT0 (ORCPT ); Mon, 19 Dec 2011 04:19:26 -0500 Received: from msa105.auone-net.jp ([61.117.18.165]:39240 "EHLO msa105.auone-net.jp" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751034Ab1LSJTY (ORCPT ); Mon, 19 Dec 2011 04:19:24 -0500 X-Greylist: delayed 362 seconds by postgrey-1.27 at vger.kernel.org; Mon, 19 Dec 2011 04:19:23 EST Date: Mon, 19 Dec 2011 18:13:19 +0900 From: Kusanagi Kouichi To: linux-kernel@vger.kernel.org Cc: John Stultz , Thomas Gleixner Subject: [PATCH] clocksource: Fix kernel-doc warnings MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.5.21 (2010-09-15) Message-Id: <20111219091320.0D5AF6FC03D@msa105.auone-net.jp> Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Fix following warnings: Warning(include/linux/clocksource.h:82): No description found for parameter 'cc' Warning(include/linux/clocksource.h:82): Excess function parameter 'tc' description in 'cyclecounter_cyc2ns' Warning(include/linux/clocksource.h:127): No description found for parameter 'cycle_tstamp' Warning(include/linux/clocksource.h:127): Excess function parameter 'cycle' description in 'timecounter_cyc2time' Warning(include/linux/clocksource.h:196): No description found for parameter 'cycle_last' Warning(include/linux/clocksource.h:196): No description found for parameter 'maxadj' Warning(include/linux/clocksource.h:196): No description found for parameter 'wd_list' Warning(include/linux/clocksource.h:196): No description found for parameter 'cs_last' Warning(include/linux/clocksource.h:196): No description found for parameter 'wd_last' Warning(include/linux/clocksource.h:270): No description found for parameter 'cycles' Warning(include/linux/clocksource.h:270): No description found for parameter 'mult' Warning(include/linux/clocksource.h:270): No description found for parameter 'shift' Warning(kernel/time/clocksource.c:661): No description found for parameter 'cs' Warning(kernel/time/clocksource.c:661): Excess function parameter 't' description in '__clocksource_updatefreq_scale' Warning(kernel/time/clocksource.c:713): No description found for parameter 'cs' Warning(kernel/time/clocksource.c:713): Excess function parameter 't' description in '__clocksource_register_scale' Warning(kernel/time/clocksource.c:736): No description found for parameter 'cs' Warning(kernel/time/clocksource.c:736): Excess function parameter 't' description in 'clocksource_register' Warning(kernel/time/clocksource.c:767): No description found for parameter 'cs' Warning(kernel/time/clocksource.c:767): No description found for parameter 'rating' Warning(kernel/time/clocksource.c:778): No description found for parameter 'cs' Warning(kernel/time/clocksource.c:798): No description found for parameter 'attr' Warning(kernel/time/clocksource.c:820): No description found for parameter 'attr' Warning(kernel/time/clocksource.c:854): No description found for parameter 'attr' Signed-off-by: Kusanagi Kouichi --- include/linux/clocksource.h | 11 ++++++++--- kernel/time/clocksource.c | 12 +++++++++--- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/include/linux/clocksource.h b/include/linux/clocksource.h index c86c940..081147d 100644 --- a/include/linux/clocksource.h +++ b/include/linux/clocksource.h @@ -71,7 +71,7 @@ struct timecounter { /** * cyclecounter_cyc2ns - converts cycle counter cycles to nanoseconds - * @tc: Pointer to cycle counter. + * @cc: Pointer to cycle counter. * @cycles: Cycles * * XXX - This could use some mult_lxl_ll() asm optimization. Same code @@ -114,7 +114,7 @@ extern u64 timecounter_read(struct timecounter *tc); * time base as values returned by * timecounter_read() * @tc: Pointer to time counter. - * @cycle: a value returned by tc->cc->read() + * @cycle_tstamp: a value returned by tc->cc->read() * * Cycle counts that are converted correctly as long as they * fall into the interval [-1/2 max cycle count, +1/2 max cycle count], @@ -156,11 +156,12 @@ extern u64 timecounter_cyc2time(struct timecounter *tc, * @mult: cycle to nanosecond multiplier * @shift: cycle to nanosecond divisor (power of two) * @max_idle_ns: max idle time permitted by the clocksource (nsecs) - * @maxadj maximum adjustment value to mult (~11%) + * @maxadj: maximum adjustment value to mult (~11%) * @flags: flags describing special properties * @archdata: arch-specific data * @suspend: suspend function for the clocksource, if necessary * @resume: resume function for the clocksource, if necessary + * @cycle_last: most recent cycle counter value seen by ::read() */ struct clocksource { /* @@ -187,6 +188,7 @@ struct clocksource { void (*suspend)(struct clocksource *cs); void (*resume)(struct clocksource *cs); + /* private: */ #ifdef CONFIG_CLOCKSOURCE_WATCHDOG /* Watchdog related data, used by the framework */ struct list_head wd_list; @@ -261,6 +263,9 @@ static inline u32 clocksource_hz2mult(u32 hz, u32 shift_constant) /** * clocksource_cyc2ns - converts clocksource cycles to nanoseconds + * @cycles: cycles + * @mult: cycle to nanosecond multiplier + * @shift: cycle to nanosecond divisor (power of two) * * Converts cycles to nanoseconds, using the given mult and shift. * diff --git a/kernel/time/clocksource.c b/kernel/time/clocksource.c index da2f760..d3ad022 100644 --- a/kernel/time/clocksource.c +++ b/kernel/time/clocksource.c @@ -647,7 +647,7 @@ static void clocksource_enqueue(struct clocksource *cs) /** * __clocksource_updatefreq_scale - Used update clocksource with new freq - * @t: clocksource to be registered + * @cs: clocksource to be registered * @scale: Scale factor multiplied against freq to get clocksource hz * @freq: clocksource frequency (cycles per second) divided by scale * @@ -699,7 +699,7 @@ EXPORT_SYMBOL_GPL(__clocksource_updatefreq_scale); /** * __clocksource_register_scale - Used to install new clocksources - * @t: clocksource to be registered + * @cs: clocksource to be registered * @scale: Scale factor multiplied against freq to get clocksource hz * @freq: clocksource frequency (cycles per second) divided by scale * @@ -727,7 +727,7 @@ EXPORT_SYMBOL_GPL(__clocksource_register_scale); /** * clocksource_register - Used to install new clocksources - * @t: clocksource to be registered + * @cs: clocksource to be registered * * Returns -EBUSY if registration fails, zero otherwise. */ @@ -761,6 +761,8 @@ static void __clocksource_change_rating(struct clocksource *cs, int rating) /** * clocksource_change_rating - Change the rating of a registered clocksource + * @cs: clocksource to be changed + * @rating: new rating */ void clocksource_change_rating(struct clocksource *cs, int rating) { @@ -772,6 +774,7 @@ EXPORT_SYMBOL(clocksource_change_rating); /** * clocksource_unregister - remove a registered clocksource + * @cs: clocksource to be unregistered */ void clocksource_unregister(struct clocksource *cs) { @@ -787,6 +790,7 @@ EXPORT_SYMBOL(clocksource_unregister); /** * sysfs_show_current_clocksources - sysfs interface for current clocksource * @dev: unused + * @attr: unused * @buf: char buffer to be filled with clocksource list * * Provides sysfs interface for listing current clocksource. @@ -807,6 +811,7 @@ sysfs_show_current_clocksources(struct sys_device *dev, /** * sysfs_override_clocksource - interface for manually overriding clocksource * @dev: unused + * @attr: unused * @buf: name of override clocksource * @count: length of buffer * @@ -842,6 +847,7 @@ static ssize_t sysfs_override_clocksource(struct sys_device *dev, /** * sysfs_show_available_clocksources - sysfs interface for listing clocksource * @dev: unused + * @attr: unused * @buf: char buffer to be filled with clocksource list * * Provides sysfs interface for listing registered clocksources -- 1.7.7.3