Skip to content

🎉 Update README to declare our support for MISRA C++ 2023 🎉 #1124

Open
MichaelRFairhurst wants to merge 1 commit intomainfrom
michaelrfairhurst/mark-misra-c++23-supported
Open

🎉 Update README to declare our support for MISRA C++ 2023 🎉 #1124
MichaelRFairhurst wants to merge 1 commit intomainfrom
michaelrfairhurst/mark-misra-c++23-supported

Conversation

@MichaelRFairhurst
Copy link
Copy Markdown
Collaborator

@MichaelRFairhurst MichaelRFairhurst commented Apr 30, 2026

Description

Still waiting on the last few rules then we can merge this! 🎉

Change request type

  • Release or process automation (GitHub workflows, internal scripts)
  • Internal documentation
  • External documentation
  • Query files (.ql, .qll, .qls or unit tests)
  • External scripts (analysis report or other code shipped as part of a release)

Rules with added or modified queries

  • No rules added
  • Queries have been added for the following rules:
    • rule number here
  • Queries have been modified for the following rules:
    • rule number here

Release change checklist

A change note (development_handbook.md#change-notes) is required for any pull request which modifies:

  • The structure or layout of the release artifacts.
  • The evaluation performance (memory, execution time) of an existing query.
  • The results of an existing query in any circumstance.

If you are only adding new rule queries, a change note is not required.

Author: Is a change note required?

  • Yes
  • No

🚨🚨🚨
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.

  • Confirmed

Reviewer: Confirm that either a change note is not required or the change note is required and has been added.

  • Confirmed

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

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    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.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Reviewer

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    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.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Copilot AI review requested due to automatic review settings April 30, 2026 15:35
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates repository documentation and metadata to reflect completed support for MISRA C++ 2023, including clarifying unsupported rules and updating documented language/compiler requirements.

Changes:

  • Mark MISRA C++ 2023 DIR-0-3-2 as not supportable and add justification in the supported-rules CSV.
  • Update the user manual to present MISRA C++ 2023 as implemented, add an explanatory footnote, and revise compiler/flag tables.
  • Update the README to list MISRA C++ 2023 as supported and to mention C++17 support, plus adjust the “under development” section.
Show a summary per file
File Description
rules.csv Adjusts MISRA C++ 2023 rule supportability metadata for DIR-0-3-2.
docs/user_manual.md Updates coverage/status for MISRA C++ 2023 and revises supported environment tables/footnotes.
README.md Declares MISRA C++ 2023 support and updates language/roadmap statements.

Copilot's findings

  • Files reviewed: 3/3 changed files
  • Comments generated: 4

Comment thread docs/user_manual.md
| 0.25.0 | 2025-01-15 | Mike Fairhurst | Add guidance for the usage of 'strict' queries. |
| 0.26.0 | 2025-02-12 | Luke Cartey | Describe support for new deviation code identifier formats |
| 0.27.0 | 2025-05-15 | Luke Cartey | Documented completed support for MISRA C 2023. |
| 0.27.0 | 2025-05-15 | Mike Fairhurst | Documented completed support for MISRA C++ 2023. |
Comment thread docs/user_manual.md
| | [2012 Amendment 4](https://misra.org.uk/app/uploads/2021/06/MISRA-C-2012-AMD4.pdf) | 22 | 22 | 21[^4] | Implemented |
| | [2023 Third Edition, Second Revision](https://misra.org.uk/product/misra-c2023/) | 221 | 210 | 207[^5] | Implemented |
| MISRA C++ | [2023](https://misra.org.uk/product/misra-cpp2023/) | 179 | 176[^6] | - | Under development |
| MISRA C++ | [2023](https://misra.org.uk/product/misra-cpp2023/) | 179 | 175[^6] | - | Implemented |
Comment thread docs/user_manual.md
Comment on lines 118 to +122
For C++ the codebase under analysis must comply with C++14 and use one of the following supported compiler configurations:

| Compiler | Version | Standard library | Target architecture | Required flags |
| -------- | ------- | ------------------- | --------------------- | -------------------------------- |
| clang | 10.0.0 | libstdc++ (default) | x86_64-linux-gnu | -std=c++14 |
| gcc | 8.4.0 | libstdc++ (default) | x86_64-linux-gnu | -std=c++14 |
| qcc | 8.3.0 | libc++ (default) | gcc_ntoaarch64le_cxx | -std=c++14 -D_QNX_SOURCE -nopipe |
| Compiler | Version | Standard library | Target architecture | Language standard flag | Other required flags |
| -------- | ------- | ------------------- | --------------------- | ---------------------------- | ----------------------- |
| clang | 10.0.0 | libstdc++ (default) | x86_64-linux-gnu | `-std=c++14` or `-std=c++17` | None |
Comment thread README.md
- [MISRA C++ 2023](https://misra.org.uk/product/misra-cpp2023/) - under development - _scheduled for release 2026 Q1/Q2_
This product intends to begin development of the following standards in the near future:

- [MISRA C 2025](https://misra.org.uk/product/misra-cpp2025/)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants