-
Notifications
You must be signed in to change notification settings - Fork 64
Add new MISRA query suites and deprecate ambiguously named suites #729
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
Conversation
* Provide a query suite for MISRA C 2012, 3rd Edition with Amendment 2 * Provide query suites for required/advisory
To avoid compatibility problems
Provide clearer naming for the MISRA C++ query suites, to avoid confusion with the MISRA C query suites.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, only noticed whitespace issues which may not matter!
Would it be a valuable follow-up to check tags against a dictionary in some of our CI package json verification scripts? So that mispellings |
Needed to specify which amendment or rule set they come from.
We validate the tags against the rule schema - that avoids the typo/mis-spelling issues, because the tags can only be from a specified list.
Great idea, I've updated the validation script to do this. |
Description
This PR makes some changes to the query suites available for MISRA C and MISRA C++:
misra-cpp-default.qls
andmisra-c-default.qls
to avoid confusion between them, and deprecated the old suites.To be able to write a query suite for the latter, I have added a set of new tags to the MISRA C queries to determine when those rules were added to the standard.
Change request type
.ql
,.qll
,.qls
or unit tests)Rules with added or modified queries
Release change checklist
A change note (development_handbook.md#change-notes) is required for any pull request which modifies:
If you are only adding new rule queries, a change note is not required.
Author: Is a change note required?
🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.
Reviewer: Confirm that either a change note is not required or the change note is required and has been added.
Query development review checklist
For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:
Author
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
Reviewer
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.