]> git.ipfire.org Git - thirdparty/git.git/commitdiff
cocci: add headings to and reword README
authorGlen Choo <chooglen@google.com>
Thu, 27 Apr 2023 22:22:22 +0000 (22:22 +0000)
committerJunio C Hamano <gitster@pobox.com>
Thu, 27 Apr 2023 23:49:15 +0000 (16:49 -0700)
- 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>
contrib/coccinelle/README

index d1daa1f62639a1bbd37e4aedf6f51c1d8d831b63..9b28ba1c57a6b99bf3487687f25d8c6fdd82d358 100644 (file)
@@ -1,7 +1,9 @@
-This directory provides examples of Coccinelle (http://coccinelle.lip6.fr/)
-semantic patches that might be useful to developers.
+= coccinelle
 
-There are two types of semantic patches:
+This directory provides Coccinelle (http://coccinelle.lip6.fr/) semantic patches
+that might be useful to developers.
+
+==  Types of semantic patches
 
  * Using the semantic transformation to check for bad patterns in the code;
    The target 'make coccicheck' is designed to check for these patterns and
@@ -42,7 +44,7 @@ There are two types of semantic patches:
    This allows to expose plans of pending large scale refactorings without
    impacting the bad pattern checks.
 
-Git-specific tips & things to know about how we run "spatch":
+== Git-specific tips & things to know about how we run "spatch":
 
  * The "make coccicheck" will piggy-back on
    "COMPUTE_HEADER_DEPENDENCIES". If you've built a given object file