mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

cocci: add headings to and reword README

Browse Source 
- 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>
This commit is contained in:
Glen Choo
2023-04-27 22:22:22 +00:00
committed by Junio C Hamano
parent 73876f4861
commit bd111141aa
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
contrib/coccinelle/README
View File

@ -1,7 +1,9 @@
This directory provides examples of Coccinelle (http://coccinelle.lip6.fr/) = coccinelle
semantic patches that might be useful to developers.
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; * Using the semantic transformation to check for bad patterns in the code;
The target 'make coccicheck' is designed to check for these patterns and 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 This allows to expose plans of pending large scale refactorings without
impacting the bad pattern checks. 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 * The "make coccicheck" will piggy-back on
"COMPUTE_HEADER_DEPENDENCIES". If you've built a given object file "COMPUTE_HEADER_DEPENDENCIES". If you've built a given object file