Skip to content

Commit 18ce5af

Browse files
committed
fix outdated info about supported build systems in README
1 parent 61b315c commit 18ce5af

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,11 @@ Currently, the toolchain consists of three "major tools":
3333
## Compatibility and Known Limitations
3434
- Generating the dot-tool-based graphics in the API documentation can increase the runtime massively, but as long as the runtime appears to be finite, they may still be worth it :)
3535
- The "additional" PlantUML-based graphics are still in a more "proof of concept" state, meaning they are not included in the documentation as neatly as the dot-tool-based graphics and could potentially be bloated due to including dependencie relations transcending the projects' source files
36-
- Test Coverage Evaluation supported for projects based on the following build systems:
37-
- meson
38-
- CMake?
39-
- Make?
40-
- Because of the more "open" nature of build systems like CMake or Make, they are nigh impossible to automatize reliably for arbitrary software projects and the user may have to manually interfere more than desirable:
41-
- For CMake and Make projects with already existing test(coverage) configurations, the user has to find out the proper arguments/"name" to run them in this way and provide them to toolchain as argument
36+
- Automated Test Coverage Evaluation supported for meson and cmake (in certain cases) projects
37+
- Because of the more "open" nature of build systems like Make or CMake, they are nigh impossible to fully automate reliably for arbitrary software projects and the user may have to manually interfere more than desirable:
38+
- For CMake projects with already existing test(coverage) configurations, the user has to find out the proper arguments/"name" to run them in this way and provide them to toolchain as argument
4239
- For CMake and Make projects with no existing configuration for tests/testcoverage, the user unfortunately may have to do some modifications to the CMakeList.txt/MAKEFILE
40+
- Test Coverage Evaluation is only possible, if a (standard) configuration for running tests already exists
4341
- Interlinking of generated API documentation and test coverage reports may fail for files/directories with duplicate names (i.e. multiple `src`directories when using subprojects). however, this likely only affects interlinking of the affected files, as linking of other files, including the index pages, should still work
4442
- We have no known setup where interlinking of API documentation and test coverage reports work for meson projects when running on Windows
4543
- issue of getting ninja recognizing a "lcov installation" on Windows

0 commit comments

Comments
 (0)