lkml.org 
[lkml]   [2020]   [Jun]   [19]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Date
SubjectRe: [PATCH] kcsan: Improve small stylistic detail in compiler-clang.h
On Fri, Jun 19, 2020 at 3:26 PM Marco Elver <elver@google.com> wrote:
>
> On Fri, Jun 19, 2020 at 02:57PM +0200, Sedat Dilek wrote:
> > Commit 5cbaefe9743bf14c9d3106db0cc19f8cb0a3ca22
> > ("kcsan: Improve various small stylistic details")
> >
> > ...forgot to improve a stylistic detail that was already done at
> > another place in compiler-clang.h file.
> >
> > Fixes: 5cbaefe9743b ("kcsan: Improve various small stylistic details")
> > Signed-off-by: Sedat Dilek <sedat.dilek@gmail.com>
> > ---
> > include/linux/compiler-clang.h | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/include/linux/compiler-clang.h b/include/linux/compiler-clang.h
> > index ee37256ec8bd..c47141b185fe 100644
> > --- a/include/linux/compiler-clang.h
> > +++ b/include/linux/compiler-clang.h
> > @@ -25,7 +25,7 @@
> > #endif
> >
> > #if __has_feature(thread_sanitizer)
> > -/* emulate gcc's __SANITIZE_THREAD__ flag */
> > +/* Emulate GCC's __SANITIZE_THREAD__ flag */
>
> Yeah, it's inconsistent, but if you look at the rest of the file, none
> of it looks particularly pretty.
>
> This change isn't really affecting KCSAN, but is a stylistic change
> confined to compiler-clang.h: while we're here, we could just bunch a
> couple of them into one patch and make it "compiler-clang.h: Improve
> comments style" or something.
>
> 1. These sentences probably want a '.' at the end.
>
> 2. Make all comments start with a capital letter, and punctuate
> correctly.
>
> 3. Multi-line comments should have the first line just '/*' and the
> second line starts the text.
>

More improvements :-).

I just fell over this one when looking through KCSAN commits in Linux v5.8-rc1+.

- Sedat -

\
 
 \ /
  Last update: 2020-06-19 15:55    [W:0.046 / U:0.416 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site