Skip to contentSkip to conversation

kcsan: Improve small stylistic detail in compiler-clang.h

PATCH In review Sedat Dilek 2 participants 3 messages Jun 19, 2020 Clang/LLVM build support

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kcsan: Improve small stylistic detail in compiler-clang.h

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")
---
 include/linux/compiler-clang.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/compiler-clang.h +1 -1
index ee37256ec8bd..c47141b185fe 100644
@@ -25,7 +25,7 @@
 #endif
 
 #if __has_feature(thread_sanitizer)
-/* emulate gcc's __SANITIZE_THREAD__ flag */
+/* Emulate GCC's __SANITIZE_THREAD__ flag */
 #define __SANITIZE_THREAD__
 #define __no_sanitize_thread \
 		__attribute__((no_sanitize("thread")))
Signature · 1 line
2.27.0
#1 lore raw
Quoted 17 lines · Sedat Dilek

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")
---
 include/linux/compiler-clang.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/compiler-clang.h +0 -0
index ee37256ec8bd..c47141b185fe 100644

include/linux/compiler-clang.h line 28

Quoted 5 lines
include/linux/compiler-clang.h +1 -1
@@ -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.

Thanks,
-- Marco

#2 lore raw
Quoted 33 lines · Marco Elver
Quoted 17 lines · Sedat Dilek

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")
---
 include/linux/compiler-clang.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/compiler-clang.h +0 -0
index ee37256ec8bd..c47141b185fe 100644

include/linux/compiler-clang.h line 28

Quoted 5 lines
include/linux/compiler-clang.h +1 -1
@@ -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.

Quoted 8 lines

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 -