diff --git a/www/userguide/images/checker_statistics.png b/www/userguide/images/checker_statistics.png index b1926d5667..d88507609b 100644 Binary files a/www/userguide/images/checker_statistics.png and b/www/userguide/images/checker_statistics.png differ diff --git a/www/userguide/images/checker_statistics_filter.png b/www/userguide/images/checker_statistics_filter.png deleted file mode 100644 index 5525c0d029..0000000000 Binary files a/www/userguide/images/checker_statistics_filter.png and /dev/null differ diff --git a/www/userguide/images/list_of_source_components.png b/www/userguide/images/list_of_source_components.png new file mode 100644 index 0000000000..0694afe348 Binary files /dev/null and b/www/userguide/images/list_of_source_components.png differ diff --git a/www/userguide/images/manage_source_components.png b/www/userguide/images/manage_source_components.png new file mode 100644 index 0000000000..215806703b Binary files /dev/null and b/www/userguide/images/manage_source_components.png differ diff --git a/www/userguide/images/remove_filtered_reports.png b/www/userguide/images/remove_filtered_reports.png new file mode 100644 index 0000000000..0fe99c9a17 Binary files /dev/null and b/www/userguide/images/remove_filtered_reports.png differ diff --git a/www/userguide/images/reports.png b/www/userguide/images/reports.png index 8223717da3..1fb1b1075e 100644 Binary files a/www/userguide/images/reports.png and b/www/userguide/images/reports.png differ diff --git a/www/userguide/userguide.md b/www/userguide/userguide.md index 56716974b2..9f0d84b424 100644 --- a/www/userguide/userguide.md +++ b/www/userguide/userguide.md @@ -23,10 +23,11 @@ Table of Contents * [Delete runs](#userguide-delete-runs) * [Sorting runs](#userguide-sorting-runs) * [Checker statistics](#userguide-checker-statistics) - * [Get statistics only for runs](#userguide-get-statistics-only-for-runs) + * [Filtering statistics](#userguide-filter-statistics) * [Uniqueing checker statistics](#userguide-checker-statistics-uniqueing) * [Analysis results](#userguide-analysis-results) * [Filtering](#userguide-filtering) + * [Remove filtered reports](#userguide-remove-filtered-reports) * [Clear report filters](#userguide-clear-report-filters) * [Unique reports](#userguide-unique-reports) * [Diff mode](#userguide-diff-mode) @@ -35,6 +36,7 @@ Table of Contents * [Review status](#userguide-review-status) * [Detection status](#userguide-detection-status) * [Severity levels](#userguide-severity-levels) + * [Manage source components](#userguide-manage-source-components) * [Bug view](#userguide-bug-view) * [Report navigation tree](#userguide-report-navigation-tree) * [Button pane](#userguide-button-pane) @@ -155,18 +157,16 @@ some attributes of the report like severity, and report status. ![Checker statistics](images/checker_statistics.png) -## Get statistics only for runs -We can get statistics only for specified runs by selecting multiple run names -using the drop-down list above the statistic tables. - -![Get statistics only for runs](images/checker_statistics_filter.png) +## Filtering statistics +We can get statistics only for specified runs, files, checker names etc. by +using the filter bar beside the statistic tables. For more information check +the report filtering [section](#userguide-filtering). ## Uniqueing checker statistics -Checker statistics results can be uniqued by using the **Unique reports** -checkbox. The same bug may appear several times if it is found on different -control paths, i.e. through different function calls. By checking -**Unique reports** a report appears only once even if it is found on several -paths. +The same bug may appear several times if it is found on different execution +paths, i.e. through different function calls. By checking **Unique reports** a +report appears only once even if it is found on several paths. By default +uniqueing is enabled for statistics. # Analysis results If you select a run at the [list of runs](#userguide-list-of-runs) view, you get @@ -180,6 +180,8 @@ run or by opening "diff view" between two runs then the following filter options are available: - [**Unique reports**](#userguide-unique-reports) - You can uniqueing the reports by checking this. +- **Report hash** - Every report has a unique (hash) identifier called Report +Identifier (RI) which can be filtered by using this input box. - **Baseline** - **Run name** - You can select one or more run names. The result list is restricted on the findings in these runs. By selecting a specific run in the @@ -226,6 +228,16 @@ When you select a filter option on any field then a number indicates on the right side of the option the number of reports which belong to that specific option. If the report count could not be determined this value will be *N/A*. +### Remove filtered reports +Filtered reports can be removed by clicking on the **Remove filtered reports** +button at the top of the filter bar. + +**!!!WARNING!!!** Once you have removed filtered reports it can not be undone. +Please make sure that you want to remove all filtered results before clicking +on this button. + +![Remove filtered reports](images/remove_filtered_reports.png) + ### Clear report filters Filter options can be cleared separately by clicking on the trash icon beside a filter or all filters can be cleared by using *Clear All Filters* button at @@ -299,6 +311,18 @@ We are mapping checker names to different severity levels: (E.g. _core.DivideZero, core.NullDereference, cplusplus.NewDelete, etc._) - **Critical** +## Manage source components +Source components are named collections of directory filters. Source components +can be managed only by administrators after clicking on the pencil icon at the +Source component filter. + +![Manage source components](images/manage_source_components.png) + +A pop-up window will be opened where you can add, edit or remove existing +source components. + +![List of source components](images/list_of_source_components.png) + # Bug view At this page you can navigate between reports and check the errors what CodeChecker found.