Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 1.93 KB

public-api.md

File metadata and controls

43 lines (31 loc) · 1.93 KB

Public API

Everything below is loaded from @rules_codechecker//:defs.bzl. Anything under @rules_codechecker//src is implementation and may change without notice.

load("@rules_codechecker//:defs.bzl", "codechecker_test")

Rules

Symbol Purpose
codechecker_test() run CodeChecker on the given targets
codechecker_suite() run CodeChecker for several platforms
codechecker_config() assemble a CodeChecker configuration
clang_tidy_test() run clang-tidy without CodeChecker
clang_analyze_test() run the Clang Static Analyzer without CodeChecker
compile_commands() generate compile_commands.json
codechecker_toolchain() provide your own tools

Building blocks

For projects writing their own rules on top of these:

Symbol Purpose
compile_commands_aspect collect sources and compile commands of a target
SourceFilesInfo provider returned by the aspect
platforms_transition transition to the platform in the rule's platform attribute
get_platform_alias() short platform name used in codechecker_suite() test names

Labels

Label Purpose
@rules_codechecker//:toolchain_type toolchain type of your own toolchain
@rules_codechecker//:default_toolchain the toolchain using tools from PATH