linux-kernel - Re: [PATCH 5/6] timekeeping: add ts/tk explaination for kernel-doc

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] [thread-next>] [day] [month] [year] [list]

Date:   Sun, 15 Nov 2020 23:19:29 +0100
From:   Thomas Gleixner <tglx@...utronix.de>
To:     Alex Shi <alex.shi@...ux.alibaba.com>, john.stultz@...aro.org
Cc:     Stephen Boyd <sboyd@...nel.org>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 5/6] timekeeping: add ts/tk explaination for kernel-doc

On Fri, Nov 13 2020 at 15:24, Alex Shi wrote:

Subject: timekeeping: add ts/tk explaination for kernel-doc

 Sentence after the colon starts with an uppercase letter.
 s/explaination/explanation/ Please use a spell checker.

Also what is ts/tk? The short log sentence has to be concise and easy to
understand and decribe what the patch does.

> this patch fixed kernel-doc mark incorrection:

'This patch fixed' ?

First of all, sentences start with an uppercase letter, but also please
do:

 # git grep 'This patch' Documentation/process/

and read the paragraph which matches.

>  /**
>   * timekeeping_inject_offset - Adds or subtracts from the current time.
> - * @tv:		pointer to the timespec variable containing the offset
> + * @ts:		pointer to the timespec variable containing the offset

This is _not_ adding documention, it's fixing the wrongly named
parameter.

Thanks,

        tglx