Devtools

Table of Contents

• Generating documentation
• Code coverage
• Binary size
• Updating Sourcegraph code search
  • Clang tidy
  • Lines of code
• Security

Generating documentation

Doxygen may be generated with:

tools/doxygen.sh

Code coverage

To generate code coverage locally:

tools/coverage.sh

Thn open coverage-report/index.html in a browser.

Binary size

To generate a binary size report, run:

tools/binary_size.sh

Then open build-binary-size/binary_size_report.html in a browser.

Updating Sourcegraph code search

Prerequisites:

• Install the src CLI: https://docs.sourcegraph.com/cli/quickstart

Run the build_sourcegraph_index script to generate compile commands and invoke scip-clang: First, generate compile commands:

tools/build_sourcegraph_index.sh

Upload it to Sourcegraph, using the src CLI:

src code-intel upload -file=index.scip

Clang tidy

clang-tidy may be invoked by building with --config=clang-tidy:

bazel build --config clang-tidy //...

Lines of code

tools/cloc.sh

Security

• Fuzzing