Skip to content

Document CodeChecker skip limitations #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lntutor wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document CodeChecker skip limitations #264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,29 @@ codechecker_test(
)
```

#### Skipping files

The `skip` argument accepts a list of patterns using the
[CodeChecker skip-file syntax](https://codechecker.readthedocs.io/en/latest/analyzer/user_guide/#skip-file).
Because CodeChecker runs inside the Bazel sandbox, skip patterns cannot use
absolute paths from the host system. Use workspace-relative patterns instead,
with a leading wildcard when the sandbox path prefix can vary:

```python
codechecker_test(
name = "your_codechecker_rule_name",
skip = [
"-*path/to/skipped/files/*",
],
targets = [
"your_target",
],
)
```

The `skip` argument is supported by both the standard analysis and the
experimental per-file analysis enabled with `per_file = True`.

#### Per-file CodeChecker analysis:
> [!IMPORTANT]
> The option is still in prototype status and is subject to changes or removal without notice. See [#31](https://github.com/Ericsson/rules_codechecker/issues/31).
Expand Down