lkml.org 
[lkml]   [2020]   [Nov]   [15]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
SubjectRe: [PATCH 5/6] timekeeping: add ts/tk explaination for kernel-doc
Date
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


\
 
 \ /
  Last update: 2020-11-15 23:21    [W:0.099 / U:0.324 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site