diff mbox series

[1/2] cocci: add headings to and reword README

Message ID 4a8b8a2a6745e791e35296e34f530b5f40f51c27.1681329955.git.gitgitgadget@gmail.com (mailing list archive)
State Superseded
Headers show
Series cocci: codify authoring and reviewing practices | expand

Commit Message

Glen Choo April 12, 2023, 8:05 p.m. UTC
From: Glen Choo <chooglen@google.com>

- Drop "examples" since we actually use the patches.
- Drop sentences that could be headings instead

Signed-off-by: Glen Choo <chooglen@google.com>
---
 contrib/coccinelle/README | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

Comments

Junio C Hamano April 12, 2023, 9:18 p.m. UTC | #1
"Glen Choo via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Glen Choo <chooglen@google.com>
>
> - Drop "examples" since we actually use the patches.
> - Drop sentences that could be headings instead
>
> Signed-off-by: Glen Choo <chooglen@google.com>
> ---
>  contrib/coccinelle/README | 10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)

Makes sense.  Will queue.  Thanks.
Glen Choo April 13, 2023, 6:37 p.m. UTC | #2
Junio C Hamano <gitster@pobox.com> writes:

>> From: Glen Choo <chooglen@google.com>
>>
>> - Drop "examples" since we actually use the patches.
>> - Drop sentences that could be headings instead
>>
>> Signed-off-by: Glen Choo <chooglen@google.com>
>> ---
>>  contrib/coccinelle/README | 10 ++++++----
>>  1 file changed, 6 insertions(+), 4 deletions(-)
>
> Makes sense.  Will queue.  Thanks.

I believe this was directed at just the cleanups in this patch and not
the recommendations in the later patch?

I was confused for a moment when I first saw this, and someone else
mentioned off-list that they also thought you meant you'd queue both
patches.
Junio C Hamano April 13, 2023, 6:51 p.m. UTC | #3
Glen Choo <chooglen@google.com> writes:

> Junio C Hamano <gitster@pobox.com> writes:
>
>>> From: Glen Choo <chooglen@google.com>
>>>
>>> - Drop "examples" since we actually use the patches.
>>> - Drop sentences that could be headings instead
>>>
>>> Signed-off-by: Glen Choo <chooglen@google.com>
>>> ---
>>>  contrib/coccinelle/README | 10 ++++++----
>>>  1 file changed, 6 insertions(+), 4 deletions(-)
>>
>> Makes sense.  Will queue.  Thanks.
>
> I believe this was directed at just the cleanups in this patch and not
> the recommendations in the later patch?
>
> I was confused for a moment when I first saw this, and someone else
> mentioned off-list that they also thought you meant you'd queue both
> patches.

Yes, I did mean that this step made sense (not implying anything
good or bad about the other step).

I ended up saving both on 'seen' so that we can keep track.  I do
not think it is a problem---people can comment more on the patch and
I expect we would update it further.

THanks.
diff mbox series

Patch

diff --git a/contrib/coccinelle/README b/contrib/coccinelle/README
index d1daa1f6263..9b28ba1c57a 100644
--- a/contrib/coccinelle/README
+++ b/contrib/coccinelle/README
@@ -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