]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
Code coverage: Apply Fred's suggestions (thanks!)
authorRemi Gacogne <remi.gacogne@powerdns.com>
Fri, 22 Sep 2023 10:03:53 +0000 (12:03 +0200)
committerRemi Gacogne <remi.gacogne@powerdns.com>
Mon, 9 Oct 2023 10:43:25 +0000 (12:43 +0200)
CODE_COVERAGE.md
pdns/coverage.cc

index 555cdffc54572e230986d684a9e7e535be29772a..4b1a471f5b1815b22c08a2903f73467a2b0f6f2d 100644 (file)
@@ -1,9 +1,9 @@
 Code Coverage
 -------------
 
-PowerDNS uses [coveralls](https://coveralls.io/) to generate code coverage reports from our Continuous Integration tests. The resulting analysis can then be consulted [online](https://coveralls.io/github/PowerDNS/pdns), and gives hindsight into which parts of the code are automatically tested.
+PowerDNS uses [coveralls](https://coveralls.io/) to generate code coverage reports from our Continuous Integration tests. The resulting analysis can then be consulted [online](https://coveralls.io/github/PowerDNS/pdns), and gives insight into which parts of the code are automatically tested.
 
-Code coverage is generated during our Continuous Integration tests, for every pull requests and pushs. In addition to the dashboard on coveralls's website, a summary is posted on pull requests.
+Code coverage is generated during our Continuous Integration tests, for every pull request. In addition to the dashboard on Coveralls' website, a summary is posted on pull requests.
 
 # Technical Details
 
@@ -73,5 +73,5 @@ It is possible to generate a code coverage report without going through the CI,
 
 # Remaining Tasks
 
-The way our code coverage report is generated does not currently handle very well the multiple tools that are generated during the authoritative server build, and end up in the `pdns-tools` package. Consequently the coverage report for these tools, and the related code parts, is not accurate.
+The way our code coverage report is generated does not currently handle the different authoritative server tools (that end up in the `pdns-tools` package) very well. Consequently the coverage report for these tools, and the related code parts, is not accurate.
 It is likely possible to pass several `--object </path/to/binary>` options to `llvm-cov` when processing the `.profdata` file.
index 71fcda4b07497d944722213b7b4baac172a83f85..3cbfa40424eb084e1d03a05687584b122288e9f6 100644 (file)
 #ifdef COVERAGE
 extern "C"
 {
-  //NOLINTNEXTLINE(bugprone-reserved-identifier): not ours
+  // NOLINTNEXTLINE(bugprone-reserved-identifier): not ours
   void __gcov_dump(void);
 #ifdef CLANG_COVERAGE
-  //NOLINTNEXTLINE(bugprone-reserved-identifier): not ours
+  // NOLINTNEXTLINE(bugprone-reserved-identifier): not ours
   int __llvm_profile_write_file(void);
 #endif /* CLANG_COVERAGE */
 }