coccinelle: misc: update uninitialized_var.cocci documentation

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

Signed-off-by: Denis Efremov <efremov@linux.com>
Signed-off-by: Julia Lawall <julia.lawall@inria.fr>
This commit is contained in:
Denis Efremov 2021-03-08 10:30:18 +03:00 committed by Julia Lawall
parent 3afb532b19
commit cb62732d3b

View File

@ -1,7 +1,9 @@
// SPDX-License-Identifier: GPL-2.0-only
///
/// Please, don't reintroduce uninitialized_var().
/// From Documentation/process/deprecated.rst:
///
/// From Documentation/process/deprecated.rst,
/// commit 4b19bec97c88 ("docs: deprecated.rst: Add uninitialized_var()"):
/// For any compiler warnings about uninitialized variables, just add
/// an initializer. Using warning-silencing tricks is dangerous as it
/// papers over real bugs (or can in the future), and suppresses unrelated
@ -11,6 +13,11 @@
/// obviously redundant, the compiler's dead-store elimination pass will make
/// sure there are no needless variable writes.
///
/// Later, commit 3942ea7a10c9 ("deprecated.rst: Remove now removed
/// uninitialized_var") removed this section because all initializations of
/// this kind were cleaned-up from the kernel. This cocci rule checks that
/// the macro is not explicitly or implicitly reintroduced.
///
// Confidence: High
// Copyright: (C) 2020 Denis Efremov ISPRAS
// Options: --no-includes --include-headers
@ -40,12 +47,10 @@ position p;
p << r.p;
@@
coccilib.report.print_report(p[0],
"WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)")
coccilib.report.print_report(p[0], "WARNING this kind of initialization is deprecated")
@script:python depends on org@
p << r.p;
@@
coccilib.org.print_todo(p[0],
"WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)")
coccilib.org.print_todo(p[0], "WARNING this kind of initialization is deprecated")