cocci: add headings to and reword README
- Drop "examples" since we actually use the patches. - Drop sentences that could be headings instead Signed-off-by: Glen Choo <chooglen@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Glen Choo committed
Apr 27, 2023 at 22:22 UTC
bd111141aa118e03c969f878540a75381d1c6e9a
1 file changed
+6
-4
contrib/coccinelle/README
+6
-4
@@ -1,7 +1,9 @@
1
-This directory provides examples of Coccinelle (http://coccinelle.lip6.fr/)
2
-semantic patches that might be useful to developers.
1
+= coccinelle
2
4
-There are two types of semantic patches:
3
+This directory provides Coccinelle (http://coccinelle.lip6.fr/) semantic patches
4
+that might be useful to developers.
5
+
6
+== Types of semantic patches
7
8
* Using the semantic transformation to check for bad patterns in the code;
9
The target 'make coccicheck' is designed to check for these patterns and
@@ -42,7 +44,7 @@ There are two types of semantic patches:
44
This allows to expose plans of pending large scale refactorings without
45
impacting the bad pattern checks.
46
45
-Git-specific tips & things to know about how we run "spatch":
47
+== Git-specific tips & things to know about how we run "spatch":
48
49
* The "make coccicheck" will piggy-back on
50
"COMPUTE_HEADER_DEPENDENCIES". If you've built a given object file