Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MISRA C - Document Zephyr's code guideline based on MISRA C 2012 #10030

Closed
ceolin opened this issue Sep 17, 2018 · 4 comments
Closed

MISRA C - Document Zephyr's code guideline based on MISRA C 2012 #10030

ceolin opened this issue Sep 17, 2018 · 4 comments
Assignees
Labels
area: MISRA-C Enhancement Changes/Updates/Additions to existing features priority: medium Medium impact/importance bug

Comments

@ceolin
Copy link
Member

ceolin commented Sep 17, 2018

We have to document our code guideline based on MISRA-C 2012 to help newcomer developers to contribute on Zephyr. Also this is important not only because of MISRA-C rules but because of patterns that we want to be followed across the project.

This document must be clear enough to make people no introduce MISRA-C violations.

part of #9552

@ceolin ceolin added Feature A planned feature with a milestone priority: medium Medium impact/importance bug area: MISRA-C labels Sep 17, 2018
@ceolin ceolin added this to the v1.14.0 milestone Sep 17, 2018
@nashif nashif added bug The issue is a bug, or the PR is fixing a bug and removed Feature A planned feature with a milestone labels Feb 21, 2019
@ceolin ceolin modified the milestones: v1.14.0, future Feb 22, 2019
@nashif nashif removed this from the future milestone May 21, 2019
@MaureenHelm MaureenHelm added Enhancement Changes/Updates/Additions to existing features and removed bug The issue is a bug, or the PR is fixing a bug labels Aug 14, 2019
@d3zd3z
Copy link
Collaborator

d3zd3z commented Dec 2, 2019

Have we gotten any clarity as to how much we can document MISRA-C compliance while still complying with the license of the MISRA-C spec itself?

@ceolin
Copy link
Member Author

ceolin commented Dec 2, 2019

Have we gotten any clarity as to how much we can document MISRA-C compliance while still complying with the license of the MISRA-C spec itself?

You mean document deviations and still be compliant ? I don't think there is a number. As far as I know you can deviate from required rules as much as you can if they are properly justified. The only thing that is not allowed is deviate from mandatory rules.

In informal talk with auditors and static analysis tool owners they told me that usually projects only select a small set of rules.

@dbkinder
Copy link
Contributor

dbkinder commented Dec 2, 2019

I read the question asking how we document the MISRA-C rules so it's all contained in our project's publically available coding guideline documentation without infringing on the MISRA-C licensing rules.

@d3zd3z
Copy link
Collaborator

d3zd3z commented Dec 2, 2019

@dbkinder that is what I was trying to say.

@nashif nashif closed this as completed May 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: MISRA-C Enhancement Changes/Updates/Additions to existing features priority: medium Medium impact/importance bug
Projects
None yet
Development

No branches or pull requests

5 participants