diff options
| author | Nikolay Ivchenko <nivchenko.dev@gmail.com> | 2026-03-01 13:25:18 +0300 |
|---|---|---|
| committer | Dmitry Vyukov <dvyukov@google.com> | 2026-03-02 22:01:55 +0000 |
| commit | 28b83e23e49dfc402a3eef2b8741a4fe03ed09fe (patch) | |
| tree | 4513abc8c02a8e42c394761621043577b278c8da /docs/coverage.md | |
| parent | b9dd65344443971a6851b68971ea6ec795c2a69d (diff) | |
docs: update grey coverage color description
Commit 59578253057fc4e1d0d94e5bc7afb12be5cf0642 removed the weak-uncovered functionality,
but the documentation still contains the description for the old coloring scheme.
Currently, lines in functions that were never executed are rendered as grey (#505050),
merging them with non-instrumented code.
This change updates the documentation to reflect that the grey color now indicates
that either the code is not instrumented or the function containing the line was
never executed.
Diffstat (limited to 'docs/coverage.md')
| -rw-r--r-- | docs/coverage.md | 12 |
1 files changed, 4 insertions, 8 deletions
diff --git a/docs/coverage.md b/docs/coverage.md index ca21c52f6..ebbdbbe6c 100644 --- a/docs/coverage.md +++ b/docs/coverage.md @@ -42,21 +42,17 @@ There are several PC values associated to the line and not all of these are exec  -### Weak-uncovered: crimson red (#c80000) - -Function (symbol) this line is in doesn't have any coverage. I.e. the function is not executed at all. Please note that if compiler have optimized certain symbol out and made the code inline instead symbol associated with this line is the one where the code is compiled into. This makes it sometimes real hard to figure out meaning of coloring. Example below shows how single line which is uncovered and PC values associated to it are in function(s) that are not executed either is shown. - - - ### Uncovered: red (#ff0000) Line is uncovered. Function (symbol) this line is in is executed and one of the PC values associated to this line. Example below shows how single line which is not covered is shown.  -### Not instrumented: grey (#505050) +### Not executed or non-instrumented code: grey (#505050) + +If an entire function was never executed, all its lines are shown in grey. This color is also used for lines that are not instrumented or do not generate code (e.g., comments, macros, or empty lines). -PC values associated to the line are not instrumented or source line doesn't generate code at all. Example below shows how all not instrumented code is shown. +Note that if a function was executed but some lines within it were not covered, those lines are shown in red, not grey.  |
