Skip to content

Commit 734e5c8

Browse files
committed
Update README.md for the codechecker
1 parent e5f7b16 commit 734e5c8

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

Utilities/Tools/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,20 @@ checkers are used by setting the O2_CHECKER_CHECKS environment variable.
1212

1313
You can see what actually happens by looking at the `alidist/o2checkcode.sh`
1414
recipe.
15+
16+
# Using the code checker on a restricted set of files
17+
18+
Often, only a few files are changed in the repository and running the codechecker
19+
on the whole repository would be a considerable overhead. It is now possible to only check
20+
files which were modified or are influenced by a modification by saying
21+
22+
```
23+
ALIBUILD_BASE_HASH=commit_id aliBuild build o2checkcode --defaults o2-daq --debug
24+
```
25+
26+
where `commit_id` is some git commit from which onwards we would like to check changed code.
27+
Typically, `commit_id` should be the commit just before new modifications are applied.
28+
Examples are `commit_id=HEAD` when we want to compare to the last git commit,
29+
or `commit_id=HEAD^^^` when we compare to the state 3 commits ago.
30+
31+
The pull request checker uses this mechanism to provide faster checks on github.

0 commit comments

Comments
 (0)