linux-kernel - Re: [PATCH -next] clocksource/drivers/timer-ti-dm: Fix some kernel-doc comments

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Fri, 14 Oct 2022 13:49:16 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Bagas Sanjaya <bagasdotme@...il.com>,
        Yang Li <yang.lee@...ux.alibaba.com>
Cc:     daniel.lezcano@...aro.org, tglx@...utronix.de,
        linux-kernel@...r.kernel.org, Abaci Robot <abaci@...ux.alibaba.com>
Subject: Re: [PATCH -next] clocksource/drivers/timer-ti-dm: Fix some
 kernel-doc comments



On 10/14/22 06:09, Bagas Sanjaya wrote:
> On Fri, Oct 14, 2022 at 05:13:57PM +0800, Yang Li wrote:
>> Fix some kernel-doc comments.
>>
>> Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=2399
> 
> What fix are you doing below? Please describe (should contain warning
> messages from bugzilla link above).

Yeah, we don't need that link, just the warning messages themselves.

> ---- ranting ----
> When I see social media posts, I often see "Link in bio" phrase. That
> is, instead of posting the full link, the link is placed on URL section
> of a poster's bio and a pointer to it is phrased in relevant posts. What
> if such "link in bio" link changes? The older posts which points to
> different link than in the bio become irrelevant.
> 
> I would rather just spell the full link in my posts instead for
> posterity.
> ---- end ranting ----
> 
>> diff --git a/drivers/clocksource/timer-ti-dm.c b/drivers/clocksource/timer-ti-dm.c
>> index cad29ded3a48..574c88584fbf 100644
>> --- a/drivers/clocksource/timer-ti-dm.c
>> +++ b/drivers/clocksource/timer-ti-dm.c
>> @@ -181,8 +181,7 @@ static inline u32 dmtimer_read(struct dmtimer *timer, u32 reg)
>>  /**
>>   * dmtimer_write - write timer registers in posted and non-posted mode
>>   * @timer:      timer pointer over which write operation is to perform
>> - * @reg:        lowest byte holds the register offset
>> - * @value:      data to write into the register
>> + * @val:      data to write into the register
>>   *
>>   * The posted mode bit is encoded in reg. Note that in posted mode, the write
>>   * pending bit must be checked. Otherwise a write on a register which has a
>> @@ -925,7 +924,7 @@ static int omap_dm_timer_set_int_enable(struct omap_dm_timer *cookie,
>>  
>>  /**
>>   * omap_dm_timer_set_int_disable - disable timer interrupts
>> - * @timer:	pointer to timer handle
>> + * @cookie:	pointer to omap dm timer handle
>>   * @mask:	bit mask of interrupts to be disabled
>>   *
>>   * Disables the specified timer interrupts for a timer.
> 
> Seems like two different fixes, right? These should be splitted into its
> own patch.

That's up to the maintainer IMO.
If I were making this patch, it would be as above, just one patch.


-- 
~Randy