diff mbox series

[1/3] CHANGELOG.md: Mention the MISRA-C improvement in 4.18 dev cycle

Message ID 20231019052050.1032492-2-Henry.Wang@arm.com (mailing list archive)
State Superseded
Headers show
Series Final CHANGELOG changes for 4.18 | expand

Commit Message

Henry Wang Oct. 19, 2023, 5:20 a.m. UTC
Signed-off-by: Henry Wang <Henry.Wang@arm.com>
---
 CHANGELOG.md | 1 +
 1 file changed, 1 insertion(+)

Comments

Stefano Stabellini Oct. 19, 2023, 4:13 p.m. UTC | #1
On Thu, 19 Oct 2023, Henry Wang wrote:
> Signed-off-by: Henry Wang <Henry.Wang@arm.com>
> ---
>  CHANGELOG.md | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/CHANGELOG.md b/CHANGELOG.md
> index 165c5caf9b..47e98f036f 100644
> --- a/CHANGELOG.md
> +++ b/CHANGELOG.md
> @@ -33,6 +33,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
>     nodes using a device tree overlay binary (.dtbo).
>   - Introduce two new hypercalls to map the vCPU runstate and time areas by
>     physical rather than linear/virtual addresses.
> + - The project has now officially adopted 72 rules of MISRA-C.

I counted them again, they are 71 today. We have accepted 3 more
recently but for the CHANGELOG.md I would stick with what is on
docs/misra/rules.rst

Assuming 72 is changed to 71 on commit:

Acked-by: Stefano Stabellini <sstabellini@kernel.org>
Henry Wang Oct. 20, 2023, 1:15 a.m. UTC | #2
Hi Stefano,

> On Oct 20, 2023, at 00:13, Stefano Stabellini <sstabellini@kernel.org> wrote:
> 
> On Thu, 19 Oct 2023, Henry Wang wrote:
>> Signed-off-by: Henry Wang <Henry.Wang@arm.com>
>> ---
>> CHANGELOG.md | 1 +
>> 1 file changed, 1 insertion(+)
>> 
>> diff --git a/CHANGELOG.md b/CHANGELOG.md
>> index 165c5caf9b..47e98f036f 100644
>> --- a/CHANGELOG.md
>> +++ b/CHANGELOG.md
>> @@ -33,6 +33,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
>>    nodes using a device tree overlay binary (.dtbo).
>>  - Introduce two new hypercalls to map the vCPU runstate and time areas by
>>    physical rather than linear/virtual addresses.
>> + - The project has now officially adopted 72 rules of MISRA-C.
> 
> I counted them again, they are 71 today. We have accepted 3 more
> recently but for the CHANGELOG.md I would stick with what is on
> docs/misra/rules.rst

lol I will send a v2.

> 
> Assuming 72 is changed to 71 on commit:
> 
> Acked-by: Stefano Stabellini <sstabellini@kernel.org>

Thanks!

Kind regards,
Henry
Henry Wang Oct. 20, 2023, 1:31 a.m. UTC | #3
Hi Stefano,

> On Oct 20, 2023, at 00:13, Stefano Stabellini <sstabellini@kernel.org> wrote:
> 
> On Thu, 19 Oct 2023, Henry Wang wrote:
>> Signed-off-by: Henry Wang <Henry.Wang@arm.com>
>> ---
>> CHANGELOG.md | 1 +
>> 1 file changed, 1 insertion(+)
>> 
>> diff --git a/CHANGELOG.md b/CHANGELOG.md
>> index 165c5caf9b..47e98f036f 100644
>> --- a/CHANGELOG.md
>> +++ b/CHANGELOG.md
>> @@ -33,6 +33,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
>>    nodes using a device tree overlay binary (.dtbo).
>>  - Introduce two new hypercalls to map the vCPU runstate and time areas by
>>    physical rather than linear/virtual addresses.
>> + - The project has now officially adopted 72 rules of MISRA-C.
> 
> I counted them again, they are 71 today. We have accepted 3 more
> recently but for the CHANGELOG.md I would stick with what is on
> docs/misra/rules.rst

Thanks for the pointer of the doc, I checked the doc and noticed that
we actually support 65 rules and 6 directives (65+6=71 so you are correct),
but to avoid the confusion, would you mind me writing in this way:
"The project has officially adopted 6 directives and 65 rules of MISRA-C”?

Kind regards,
Henry
Stefano Stabellini Oct. 20, 2023, 1:47 a.m. UTC | #4
On Fri, 20 Oct 2023, Henry Wang wrote:
> Hi Stefano,
> 
> > On Oct 20, 2023, at 00:13, Stefano Stabellini <sstabellini@kernel.org> wrote:
> > 
> > On Thu, 19 Oct 2023, Henry Wang wrote:
> >> Signed-off-by: Henry Wang <Henry.Wang@arm.com>
> >> ---
> >> CHANGELOG.md | 1 +
> >> 1 file changed, 1 insertion(+)
> >> 
> >> diff --git a/CHANGELOG.md b/CHANGELOG.md
> >> index 165c5caf9b..47e98f036f 100644
> >> --- a/CHANGELOG.md
> >> +++ b/CHANGELOG.md
> >> @@ -33,6 +33,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
> >>    nodes using a device tree overlay binary (.dtbo).
> >>  - Introduce two new hypercalls to map the vCPU runstate and time areas by
> >>    physical rather than linear/virtual addresses.
> >> + - The project has now officially adopted 72 rules of MISRA-C.
> > 
> > I counted them again, they are 71 today. We have accepted 3 more
> > recently but for the CHANGELOG.md I would stick with what is on
> > docs/misra/rules.rst
> 
> Thanks for the pointer of the doc, I checked the doc and noticed that
> we actually support 65 rules and 6 directives (65+6=71 so you are correct),
> but to avoid the confusion, would you mind me writing in this way:
> "The project has officially adopted 6 directives and 65 rules of MISRA-C”?

Sure that's fine!
Nicola Vetrini Oct. 20, 2023, 6:28 a.m. UTC | #5
On 20/10/2023 03:31, Henry Wang wrote:
> Hi Stefano,
> 
>> On Oct 20, 2023, at 00:13, Stefano Stabellini <sstabellini@kernel.org> 
>> wrote:
>> 
>> On Thu, 19 Oct 2023, Henry Wang wrote:
>>> Signed-off-by: Henry Wang <Henry.Wang@arm.com>
>>> ---
>>> CHANGELOG.md | 1 +
>>> 1 file changed, 1 insertion(+)
>>> 
>>> diff --git a/CHANGELOG.md b/CHANGELOG.md
>>> index 165c5caf9b..47e98f036f 100644
>>> --- a/CHANGELOG.md
>>> +++ b/CHANGELOG.md
>>> @@ -33,6 +33,7 @@ The format is based on [Keep a 
>>> Changelog](https://keepachangelog.com/en/1.0.0/)
>>>    nodes using a device tree overlay binary (.dtbo).
>>>  - Introduce two new hypercalls to map the vCPU runstate and time 
>>> areas by
>>>    physical rather than linear/virtual addresses.
>>> + - The project has now officially adopted 72 rules of MISRA-C.
>> 
>> I counted them again, they are 71 today. We have accepted 3 more
>> recently but for the CHANGELOG.md I would stick with what is on
>> docs/misra/rules.rst
> 
> Thanks for the pointer of the doc, I checked the doc and noticed that
> we actually support 65 rules and 6 directives (65+6=71 so you are 
> correct),
> but to avoid the confusion, would you mind me writing in this way:
> "The project has officially adopted 6 directives and 65 rules of 
> MISRA-C”?
> 
> Kind regards,
> Henry

Just dropping this small suggestion: the general term used by MISRA to 
indicate either
a Rule or a Directive is Guideline, so it's also correct to say that 71 
Guidelines have been
adopted.
Henry Wang Oct. 20, 2023, 6:31 a.m. UTC | #6
Hi Nicola,

> On Oct 20, 2023, at 14:28, Nicola Vetrini <nicola.vetrini@bugseng.com> wrote:
> 
> On 20/10/2023 03:31, Henry Wang wrote:
>> Hi Stefano,
>>> On Oct 20, 2023, at 00:13, Stefano Stabellini <sstabellini@kernel.org> wrote:
>>> On Thu, 19 Oct 2023, Henry Wang wrote:
>>>> Signed-off-by: Henry Wang <Henry.Wang@arm.com>
>>>> ---
>>>> CHANGELOG.md | 1 +
>>>> 1 file changed, 1 insertion(+)
>>>> diff --git a/CHANGELOG.md b/CHANGELOG.md
>>>> index 165c5caf9b..47e98f036f 100644
>>>> --- a/CHANGELOG.md
>>>> +++ b/CHANGELOG.md
>>>> @@ -33,6 +33,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
>>>>   nodes using a device tree overlay binary (.dtbo).
>>>> - Introduce two new hypercalls to map the vCPU runstate and time areas by
>>>>   physical rather than linear/virtual addresses.
>>>> + - The project has now officially adopted 72 rules of MISRA-C.
>>> I counted them again, they are 71 today. We have accepted 3 more
>>> recently but for the CHANGELOG.md I would stick with what is on
>>> docs/misra/rules.rst
>> Thanks for the pointer of the doc, I checked the doc and noticed that
>> we actually support 65 rules and 6 directives (65+6=71 so you are correct),
>> but to avoid the confusion, would you mind me writing in this way:
>> "The project has officially adopted 6 directives and 65 rules of MISRA-C”?
>> Kind regards,
>> Henry
> 
> Just dropping this small suggestion: the general term used by MISRA to indicate either
> a Rule or a Directive is Guideline, so it's also correct to say that 71 Guidelines have been
> adopted.

Correct, I wrote separately just to simply keep some consistency between the wording that
we already did for 4.17, see [1].

[1] https://xenbits.xen.org/gitweb/?p=xen.git;a=blob;f=CHANGELOG.md;h=165c5caf9beaff72da4ea07d326743500f470466;hb=HEAD#l55

Kind regards,
Henry

> 
> -- 
> Nicola Vetrini, BSc
> Software Engineer, BUGSENG srl (https://bugseng.com)
diff mbox series

Patch

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 165c5caf9b..47e98f036f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -33,6 +33,7 @@  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
    nodes using a device tree overlay binary (.dtbo).
  - Introduce two new hypercalls to map the vCPU runstate and time areas by
    physical rather than linear/virtual addresses.
+ - The project has now officially adopted 72 rules of MISRA-C.
 
 ### Removed
  - On x86, the "pku" command line option has been removed.  It has never