coccicheck: refer to Documentation/coccinelle.txt and wiki
authorLuis R. Rodriguez <mcgrof@kernel.org>
Wed, 29 Jun 2016 22:14:58 +0000 (15:14 -0700)
committerMichal Marek <mmarek@suse.com>
Fri, 22 Jul 2016 10:13:39 +0000 (12:13 +0200)
Refer to the Documentation/coccinelle.txt and supplemental documentation
on the wiki:

https://bottest.wiki.kernel.org/coccicheck

This page shall always refer to the linux-next iteration of scripts/coccicheck.

v4: only refer to the wiki as supplemental documentation, and also
    update Documentation/coccinelle.txt.

Signed-off-by: Luis R. Rodriguez <mcgrof@kernel.org>
Acked-by: Nicolas Palix <nicolas.palix@imag.fr>
Signed-off-by: Michal Marek <mmarek@suse.com>
Documentation/coccinelle.txt
scripts/coccicheck

index 1c26908ebc16da03a93978be33cf19043b56342b..01fb1dae3163ca569045b2ce2a3c2b395bb7d217 100644 (file)
@@ -38,6 +38,15 @@ as a regular user, and install it with
 
         sudo make install
 
+ Supplemental documentation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For supplemental documentation refer to the wiki:
+
+https://bottest.wiki.kernel.org/coccicheck
+
+The wiki documentation always refers to the linux-next version of the script.
+
  Using Coccinelle on the Linux kernel
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
index f9293ab04a8bb879bc1dee83d8fa1ccc0159cb89..c92c1528a54dd54589878df99c2d9bb8dd4c09aa 100755 (executable)
@@ -1,9 +1,10 @@
 #!/bin/bash
-
+# Linux kernel coccicheck
+#
+# Read Documentation/coccinelle.txt
 #
 # This script requires at least spatch
 # version 1.0.0-rc11.
-#
 
 DIR="$(dirname $(readlink -f $0))/.."
 SPATCH="`which ${SPATCH:=spatch}`"