diff options
| author | Himanshu Jha <himanshujha199640@gmail.com> | 2018-08-13 16:16:38 +0530 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2018-08-31 16:51:59 -0600 |
| commit | 9eff4a2e92a2ea8e8364976a699e3a03937c3457 (patch) | |
| tree | 8ad7917338aa8bfda954f0b8a42c7075540a0412 /Documentation/dev-tools/coccinelle.rst | |
| parent | 9799445af124c2476c7e0cc5432375348b6a4724 (diff) | |
| download | linux-9eff4a2e92a2ea8e8364976a699e3a03937c3457.tar.gz linux-9eff4a2e92a2ea8e8364976a699e3a03937c3457.tar.bz2 linux-9eff4a2e92a2ea8e8364976a699e3a03937c3457.zip | |
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 <himanshujha199640@gmail.com>
Acked-by: Julia Lawall <julia.lawall@lip6.fr>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/dev-tools/coccinelle.rst')
| -rw-r--r-- | Documentation/dev-tools/coccinelle.rst | 23 |
1 files changed, 19 insertions, 4 deletions
diff --git a/Documentation/dev-tools/coccinelle.rst b/Documentation/dev-tools/coccinelle.rst index 94f41c290bfc..aa14f05cabb1 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 http://coccinelle.lip6.fr/ -Once you have it, run the following command:: +Or from Github at: - ./configure +https://github.com/coccinelle/coccinelle + +Once you have it, run the following commands:: + + ./autogen + ./configure make as a regular user, and install it with:: sudo make install +More detailed installation instructions to build from source can be +found at: + +https://github.com/coccinelle/coccinelle/blob/master/install.txt + Supplemental documentation --------------------------- @@ -51,6 +62,10 @@ https://bottest.wiki.kernel.org/coccicheck The wiki documentation always refers to the linux-next version of the script. +For Semantic Patch Language(SmPL) grammar documentation refer to: + +http://coccinelle.lip6.fr/documentation.php + 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:: |