History

coccinelle: misc: update uninitialized_var.cocci documentation

Remove the documentation link from the warning message because commit 3942ea7a10c9 ("deprecated.rst: Remove now removed uninitialized_var") removed the section from documentation. Update the rule documentation accordingly.

Denis Efremov committed 5 years ago

Commit cb627321 parent 3afb5321 file · +10 −5Browse files

Unified · Split

scripts/coccinelle/misc/uninitialized_var.cocci+10−5
@@ -1,7 +1,9 @@
1// SPDX-License-Identifier: GPL-2.0-only1// SPDX-License-Identifier: GPL-2.0-only
2///2///
3/// Please, don't reintroduce uninitialized_var().3/// Please, don't reintroduce uninitialized_var().
4/// From Documentation/process/deprecated.rst:4///
5/// From Documentation/process/deprecated.rst,
6/// commit 4b19bec97c88 ("docs: deprecated.rst: Add uninitialized_var()"):
5/// For any compiler warnings about uninitialized variables, just add7/// For any compiler warnings about uninitialized variables, just add
6/// an initializer. Using warning-silencing tricks is dangerous as it8/// an initializer. Using warning-silencing tricks is dangerous as it
7/// papers over real bugs (or can in the future), and suppresses unrelated9/// papers over real bugs (or can in the future), and suppresses unrelated
@@ -11,6 +13,11 @@ · 3 unmodified lines
11/// obviously redundant, the compiler's dead-store elimination pass will make13/// obviously redundant, the compiler's dead-store elimination pass will make
12/// sure there are no needless variable writes.14/// sure there are no needless variable writes.
13///15///
16/// Later, commit 3942ea7a10c9 ("deprecated.rst: Remove now removed
17/// uninitialized_var") removed this section because all initializations of
18/// this kind were cleaned-up from the kernel. This cocci rule checks that
19/// the macro is not explicitly or implicitly reintroduced.
20///
14// Confidence: High21// Confidence: High
15// Copyright: (C) 2020 Denis Efremov ISPRAS22// Copyright: (C) 2020 Denis Efremov ISPRAS
16// Options: --no-includes --include-headers23// Options: --no-includes --include-headers
@@ -40,12 +47,10 @@ position p; · 23 unmodified lines
40p << r.p;47p << r.p;
41@@48@@
42 49
43coccilib.report.print_report(p[0],50coccilib.report.print_report(p[0], "WARNING this kind of initialization is deprecated")
44 "WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)")
45 51
46@script:python depends on org@52@script:python depends on org@
47p << r.p;53p << r.p;
48@@54@@
49 55
50coccilib.org.print_todo(p[0],56coccilib.org.print_todo(p[0], "WARNING this kind of initialization is deprecated")
51 "WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)")