Messages in this thread | | | From | Thomas Gleixner <> | Subject | Re: [PATCH 5/6] timekeeping: add ts/tk explaination for kernel-doc | Date | Sun, 15 Nov 2020 23:19:29 +0100 |
| |
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
| |