Commit 9eff4a2e authored by Himanshu Jha's avatar Himanshu Jha Committed by Jonathan Corbet
Browse files

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: default avatarHimanshu Jha <himanshujha199640@gmail.com>
Acked-by: default avatarJulia Lawall <julia.lawall@lip6.fr>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 9799445a

Documentation/dev-tools/coccinelle.rst

+19 −4
Original line number Diff line number Diff line
@@ -30,11 +30,17 @@ 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:



https://github.com/coccinelle/coccinelle



Once you have it, run the following commands::



        ./autogen

        ./configure

        make
@@ -42,6 +48,11 @@ 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

------------------------------------

CRA Git | Maintained and supported by SUSTech CRA and CCSE