All of lore.kernel.org
 help / color / mirror / Atom feed
From: mcgrof@kernel.org (Luis R. Rodriguez)
To: cocci@systeme.lip6.fr
Subject: [Cocci] [RFC v4 8/9] coccicheck: refer to Documentation/coccinelle.txt and wiki
Date: Wed, 29 Jun 2016 15:10:25 -0700	[thread overview]
Message-ID: <1467238226-10822-9-git-send-email-mcgrof@kernel.org> (raw)
In-Reply-To: <1467238226-10822-1-git-send-email-mcgrof@kernel.org>

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>
---
 Documentation/coccinelle.txt | 9 +++++++++
 scripts/coccicheck           | 5 +++--
 2 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/Documentation/coccinelle.txt b/Documentation/coccinelle.txt
index b90aa0bc8d6c..e35c0fdf1fef 100644
--- a/Documentation/coccinelle.txt
+++ b/Documentation/coccinelle.txt
@@ -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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/scripts/coccicheck b/scripts/coccicheck
index 0552e6152692..6676b528cfad 100755
--- a/scripts/coccicheck
+++ b/scripts/coccicheck
@@ -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}`"
-- 
2.8.4

WARNING: multiple messages have this Message-ID (diff)
From: "Luis R. Rodriguez" <mcgrof@kernel.org>
To: Julia.Lawall@lip6.fr, nicolas.palix@imag.fr,
	Gilles.Muller@lip6.fr, mmarek@suse.com
Cc: akpm@linux-foundation.org, gregkh@linuxfoundation.org,
	markivx@codeaurora.org, stephen.boyd@linaro.org,
	zohar@linux.vnet.ibm.com, broonie@kernel.org,
	ming.lei@canonical.com, tiwai@suse.d, johannes@sipsolutions.net,
	chunkeey@googlemail.com, hauke@hauke-m.de,
	jwboyer@fedoraproject.org, dmitry.torokhov@gmail.com,
	dwmw2@infradead.org, jslaby@suse.com,
	torvalds@linux-foundation.org, deepa.kernel@gmail.com,
	keescook@chromium.org, cocci@systeme.lip6.fr,
	linux-kernel@vger.kernel.org,
	"Luis R. Rodriguez" <mcgrof@kernel.org>
Subject: [RFC v4 8/9] coccicheck: refer to Documentation/coccinelle.txt and wiki
Date: Wed, 29 Jun 2016 15:10:25 -0700	[thread overview]
Message-ID: <1467238226-10822-9-git-send-email-mcgrof@kernel.org> (raw)
In-Reply-To: <1467238226-10822-1-git-send-email-mcgrof@kernel.org>

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>
---
 Documentation/coccinelle.txt | 9 +++++++++
 scripts/coccicheck           | 5 +++--
 2 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/Documentation/coccinelle.txt b/Documentation/coccinelle.txt
index b90aa0bc8d6c..e35c0fdf1fef 100644
--- a/Documentation/coccinelle.txt
+++ b/Documentation/coccinelle.txt
@@ -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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/scripts/coccicheck b/scripts/coccicheck
index 0552e6152692..6676b528cfad 100755
--- a/scripts/coccicheck
+++ b/scripts/coccicheck
@@ -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}`"
-- 
2.8.4

  parent reply	other threads:[~2016-06-29 22:10 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-06-29 22:10 [Cocci] [RFC v4 0/9] coccicheck: private review for modernization Luis R. Rodriguez
2016-06-29 22:10 ` Luis R. Rodriguez
2016-06-29 22:10 ` [Cocci] [RFC v4 1/9] coccicheck: move spatch binary check up Luis R. Rodriguez
2016-06-29 22:10   ` Luis R. Rodriguez
2016-06-29 22:10 ` [Cocci] [RFC v4 2/9] coccicheck: make SPFLAGS more useful Luis R. Rodriguez
2016-06-29 22:10   ` Luis R. Rodriguez
2016-06-29 22:10 ` [Cocci] [RFC v4 3/9] coccicheck: enable parmap support Luis R. Rodriguez
2016-06-29 22:10   ` Luis R. Rodriguez
2016-06-29 22:10 ` [Cocci] [RFC v4 4/9] coccicheck: add support for DEBUG_FILE Luis R. Rodriguez
2016-06-29 22:10   ` Luis R. Rodriguez
2016-06-29 22:10 ` [Cocci] [RFC v4 5/9] coccicheck: replace --very-quiet with --quit when debugging Luis R. Rodriguez
2016-06-29 22:10   ` Luis R. Rodriguez
2016-06-29 22:10 ` [Cocci] [RFC v4 6/9] scripts: add Linux .cocciconfig for coccinelle Luis R. Rodriguez
2016-06-29 22:10   ` Luis R. Rodriguez
2016-06-29 22:10 ` [Cocci] [RFC v4 7/9] coccicheck: add support for requring a coccinelle version Luis R. Rodriguez
2016-06-29 22:10   ` Luis R. Rodriguez
2016-06-29 22:10 ` Luis R. Rodriguez [this message]
2016-06-29 22:10   ` [RFC v4 8/9] coccicheck: refer to Documentation/coccinelle.txt and wiki Luis R. Rodriguez
2016-06-29 22:10 ` [Cocci] [RFC v4 9/9] scripts/coccinelle: require coccinelle >= 1.0.4 on device_node_continue.cocci Luis R. Rodriguez
2016-06-29 22:10   ` Luis R. Rodriguez
2016-06-29 22:14 ` [Cocci] [RFC v4 0/9] coccicheck: private review for modernization Luis R. Rodriguez
2016-06-29 22:14   ` Luis R. Rodriguez

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1467238226-10822-9-git-send-email-mcgrof@kernel.org \
    --to=mcgrof@kernel.org \
    --cc=cocci@systeme.lip6.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.