Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 8e91bcc

Browse filesBrowse files
committed
Add missing deviation analysis report tables
1 parent 4c5407b commit 8e91bcc
Copy full SHA for 8e91bcc

File tree

Expand file treeCollapse file tree

1 file changed

+23
-7
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+23
-7
lines changed

‎docs/user_manual.md

Copy file name to clipboardExpand all lines: docs/user_manual.md
+23-7Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717
| 0.9.0 | 2022-02-17 | Remco Vermeulen | Finalize scope deviation records |
1818
| 0.10.0 | 2022-02-28 | Remco Vermeulen | Describe database correctness in the Hazard and Risk Analysis (HARA). |
1919
| 0.11.0 | 2022-02-28 | Remco Vermeulen | Updated version to 1.1.0 |
20-
| 0.11.0 | 2022-10-21 | Luke Cartey | Updated version to 2.10.0 |
20+
| 0.12.0 | 2022-10-21 | Luke Cartey | Updated version to 2.10.0 |
21+
| 0.13.0 | 2022-11-03 | Remco Vermeulen | Add missing deviation analysis report tables to section 'Producing an analysis report'. |
2122

2223
## Release information
2324

@@ -44,12 +45,12 @@ A _coding standard_ is a set of rules or guidelines which restrict or prohibit t
4445

4546
The _CodeQL Coding Standards_ product is a set of CodeQL queries for identifying contraventions of rules in the following coding standards:
4647

47-
| Standard | Version | Total rules | Total supportable rules | Status |
48-
| ---------------------------------------------------------------------------------------------------------------------- | ------- | ----------- | ----------------------- | ----------- |
49-
| [AUTOSAR C++](https://www.autosar.org/fileadmin/user_upload/standards/adaptive/20-11/AUTOSAR_RS_CPP14Guidelines.pdf) | 20-11 | 397 | 375 | Implemented |
50-
| [CERT-C++](https://resources.sei.cmu.edu/downloads/secure-coding/assets/sei-cert-cpp-coding-standard-2016-v01.pdf) | 2016 | 83 | 83 | Implemented |
51-
| [CERT C](https://resources.sei.cmu.edu/downloads/secure-coding/assets/sei-cert-c-coding-standard-2016-v01.pdf) | 2016 | 99 | 99 | Under development |
52-
| [MISRA C](https://www.misra.org.uk/product/misra-c2012-third-edition-first-revision/) | 2012 | 172 | 169 | Under development |
48+
| Standard | Version | Total rules | Total supportable rules | Status |
49+
| -------------------------------------------------------------------------------------------------------------------- | ------- | ----------- | ----------------------- | ----------------- |
50+
| [AUTOSAR C++](https://www.autosar.org/fileadmin/user_upload/standards/adaptive/20-11/AUTOSAR_RS_CPP14Guidelines.pdf) | 20-11 | 397 | 375 | Implemented |
51+
| [CERT-C++](https://resources.sei.cmu.edu/downloads/secure-coding/assets/sei-cert-cpp-coding-standard-2016-v01.pdf) | 2016 | 83 | 83 | Implemented |
52+
| [CERT C](https://resources.sei.cmu.edu/downloads/secure-coding/assets/sei-cert-c-coding-standard-2016-v01.pdf) | 2016 | 99 | 99 | Under development |
53+
| [MISRA C](https://www.misra.org.uk/product/misra-c2012-third-edition-first-revision/) | 2012 | 172 | 169 | Under development |
5354

5455

5556
Not all rules in these standards are amenable to static analysis by CodeQL - some rules require external or domain specific knowledge to validate, or refer to properties which are not present in the our representation of the codebase under analysis. For each rule we therefore identify whether it is supportable or not. Furthermore, a rule can be supported in two ways:
@@ -225,6 +226,21 @@ This will produce a directory (`<output_directory>`) containing the following re
225226
- A textual justification of the deviation.
226227
- A textual description of background information.
227228
- A textual description of the requirements which must be satisfied to use the deviation.
229+
- A table of invalid deviation records for which we list:
230+
- The location of the invalid deviation record in the database.
231+
- The reason why it is considered invalid.
232+
- A table of deviation permits for which we list:
233+
- An identifier that identifies the permit.
234+
- An identifier for the coding standards rule the deviation applies to.
235+
- The query identifier that implements the guideline.
236+
- An inferred scope that shows the files or code-identifier the deviation is applied to.
237+
- A textual description of the scope when the deviation can be applied.
238+
- A textual justification of the deviation.
239+
- A textual description of background information.
240+
- A textual description of the requirements which must be satisfied to use the deviation.
241+
- A table of invalid deviation permits for which we list:
242+
- The location of the invalid permit in the database.
243+
- The reason why it is considered invalid.
228244

229245
#### Applying deviations
230246

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.