[lkml]   [2018]   [Aug]   [13]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
Messages in this thread
Patch in this message
Subject[PATCH] docs: dev-tools: coccinelle: Update documentation
* Fix install instruction by adding `./autogen` command
before `./configure`.
* Add link to a more detailed installation instruction.
* Add link to SmPL grammar documentation.
* Add single space after ',' to slightly improve readability.

Signed-off-by: Himanshu Jha <>
Documentation/dev-tools/coccinelle.rst | 23 +++++++++++++++++++----
1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/Documentation/dev-tools/coccinelle.rst b/Documentation/dev-tools/coccinelle.rst
index 94f41c290bfc..f8305cd55186 100644
--- a/Documentation/dev-tools/coccinelle.rst
+++ b/Documentation/dev-tools/coccinelle.rst
@@ -30,18 +30,29 @@ of many distributions, e.g. :
- NetBSD
- FreeBSD

-You can get the latest version released from the Coccinelle homepage at
+Some distribution packages are obsolete and it is recommended
+to use the latest version released from the Coccinelle homepage at

-Once you have it, run the following command::
+Or Github at:

- ./configure
+Once you have it, run the following commands::
+ ./autogen
+ ./configure

as a regular user, and install it with::

sudo make install

+More detailed installation instruction to build from source can be
+found at:
Supplemental documentation

@@ -51,6 +62,10 @@

The wiki documentation always refers to the linux-next version of the script.

+For Semantic Patch Language(SmPL) grammar documentation refer to:
Using Coccinelle on the Linux kernel

@@ -223,7 +238,7 @@ Since coccicheck runs through make, it naturally runs from the kernel
proper dir, as such the second rule above would be implied for picking up a
.cocciconfig when using ``make coccicheck``.

-``make coccicheck`` also supports using M= targets.If you do not supply
+``make coccicheck`` also supports using M= targets. If you do not supply
any M= target, it is assumed you want to target the entire kernel.
The kernel coccicheck script has::

 \ /
  Last update: 2018-08-13 12:37    [W:0.038 / U:2.044 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site