Skip to content

Commit 01293f4

Browse files
authored
Merge pull request #341 from github/lcartey/compiler-support
User manual: update list of supported compiler configurations.
2 parents 70f0948 + 989fe99 commit 01293f4

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

docs/user_manual.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
| 0.14.0 | 2022-11-03 | Remco Vermeulen | Add guideline recategorization plan. |
2323
| 0.15.0 | 2023-05-24 | Mauro Baluda | Clarify AUTOSAR C++ supported versions. |
2424
| 0.16.0 | 2023-07-03 | Luke Cartey | Remove reference to LGTM, update the name of the query pack |
25+
| 0.17.0 | 2023-08-16 | Luke Cartey | Update list of supported compiler configurations. |
2526

2627
## Release information
2728

@@ -89,23 +90,29 @@ In addition, the machine which performs the analysis must be able to complete a
8990

9091
#### C++
9192

92-
For C++ the codebase under analysis must:
93-
* Comply with C++14
94-
* Use one of the following supported compilers:
95-
- Clang version 10
93+
For C++ the codebase under analysis must comply with C++14 and use one of the following supported compiler configurations:
94+
95+
| Compiler | Version | Standard library | Target architecture | Required flags |
96+
| -------- | ------- | ------------------- | --------------------- | -------------------------------- |
97+
| clang | 10.0.0 | libstdc++ (default) | x86_64-linux-gnu | -std=c++14 |
98+
| gcc | 8.4.0 | libstdc++ (default) | x86_64-linux-gnu | -std=c++14 |
99+
| qcc | 8.3.0 | libc++ (default) | gcc_ntoaarch64le_cxx | -std=c++14 -D_QNX_SOURCE -nopipe |
96100

97101
Use of the queries outside these scenarios is possible, but not validated for functional safety. In particular:
98102
- Use of the queries against codebases written with more recent versions of C++ (as supported by CodeQL) are not validated in the following circumstances:
99103
- When new language features are used
100104
- When language features are used which have a differing interpretation from C++14.
101-
- Use of the queries against codebases which use other compilers or other compiler versions supported by CodeQL (e.g. gcc) is not tested or validated for functional safety.
105+
- Use of the queries against codebases which use other compilers or other compiler versions supported by CodeQL is not tested or validated for functional safety.
102106

103107
#### C
104108

105-
For C the codebase under analysis must:
106-
* Comply with C99 or C11.
107-
* Use one of the following supported compilers:
108-
- Clang version 10
109+
For C the codebase under analysis must comply with C99 or C11 and use one of the following supported compiler configurations:
110+
111+
| Compiler | Version | Standard library | Target architecture | Required Flags |
112+
| -------- | ------- | ------------------- | --------------------- | -------------------------- |
113+
| clang | 10.0.0 | glibc (default) | x86_64-linux-gnu | -std=c11 |
114+
| gcc | 8.4.0 | glibc (default) | x86_64-linux-gnu | -std=c11 |
115+
| qcc | 8.3.0 | glibc (default) | gcc_ntoaarch64le | -std=c11 -nopipe |
109116

110117
Use of the queries outside these scenarios is possible, but not validated for functional safety. In particular:
111118
- Use of the queries against codebases written with more recent versions of C (as supported by CodeQL) are not validated in the following circumstances:

0 commit comments

Comments
 (0)