diff --git a/docs/README.md b/docs/README.md index fc1af7c95a..5910e7996d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -140,7 +140,7 @@ For more information how to use CodeChecker see our [user guide](usage.md). ## Web based report management * [Webserver User Guide](web/user_guide.md) -* [WEB GUI User Guide](/web/server/www/userguide/userguide.md) +* [WEB GUI User Guide](/web/server/vue-cli/src/assets/userguide/userguide.md) * [Command line and WEB UI Feature overview](feature_comparison.md) * Security configuration * [Configuring Authentication](web/authentication.md) diff --git a/web/server/vue-cli/src/assets/userguide/images/button_pane.png b/web/server/vue-cli/src/assets/userguide/images/button_pane.png deleted file mode 100644 index 8908da4bcf..0000000000 Binary files a/web/server/vue-cli/src/assets/userguide/images/button_pane.png and /dev/null differ diff --git a/web/server/vue-cli/src/assets/userguide/images/checker_statistics.png b/web/server/vue-cli/src/assets/userguide/images/checker_statistics.png deleted file mode 100644 index 59a32153d8..0000000000 Binary files a/web/server/vue-cli/src/assets/userguide/images/checker_statistics.png and /dev/null differ diff --git a/web/server/vue-cli/src/assets/userguide/images/manage_source_components.png b/web/server/vue-cli/src/assets/userguide/images/manage_source_components.png deleted file mode 100644 index d1c0c0f59f..0000000000 Binary files a/web/server/vue-cli/src/assets/userguide/images/manage_source_components.png and /dev/null differ diff --git a/web/server/vue-cli/src/assets/userguide/images/bug_path_length_filter.png b/web/server/vue-cli/src/assets/userguide/images/new_features/6.10.0/bug_path_length_filter.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/bug_path_length_filter.png rename to web/server/vue-cli/src/assets/userguide/images/new_features/6.10.0/bug_path_length_filter.png diff --git a/web/server/vue-cli/src/assets/userguide/images/component_filter.png b/web/server/vue-cli/src/assets/userguide/images/new_features/6.7.0/component_filter.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/component_filter.png rename to web/server/vue-cli/src/assets/userguide/images/new_features/6.7.0/component_filter.png diff --git a/web/server/vue-cli/src/assets/userguide/images/plist_to_html_index.png b/web/server/vue-cli/src/assets/userguide/images/new_features/6.7.0/plist_to_html_index.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/plist_to_html_index.png rename to web/server/vue-cli/src/assets/userguide/images/new_features/6.7.0/plist_to_html_index.png diff --git a/web/server/vue-cli/src/assets/userguide/images/analysis_statistics.png b/web/server/vue-cli/src/assets/userguide/images/new_features/6.8.0/analysis_statistics.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/analysis_statistics.png rename to web/server/vue-cli/src/assets/userguide/images/new_features/6.8.0/analysis_statistics.png diff --git a/web/server/vue-cli/src/assets/userguide/images/report_hash_filter.png b/web/server/vue-cli/src/assets/userguide/images/new_features/6.8.0/report_hash_filter.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/report_hash_filter.png rename to web/server/vue-cli/src/assets/userguide/images/new_features/6.8.0/report_hash_filter.png diff --git a/web/server/vue-cli/src/assets/userguide/images/macro_expansion.png b/web/server/vue-cli/src/assets/userguide/images/new_features/6.9.1/macro_expansion.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/macro_expansion.png rename to web/server/vue-cli/src/assets/userguide/images/new_features/6.9.1/macro_expansion.png diff --git a/web/server/vue-cli/src/assets/userguide/images/new_product.png b/web/server/vue-cli/src/assets/userguide/images/new_product.png deleted file mode 100644 index 87c8935f78..0000000000 Binary files a/web/server/vue-cli/src/assets/userguide/images/new_product.png and /dev/null differ diff --git a/web/server/vue-cli/src/assets/userguide/images/notification.png b/web/server/vue-cli/src/assets/userguide/images/notification.png deleted file mode 100644 index 1ddd94fca7..0000000000 Binary files a/web/server/vue-cli/src/assets/userguide/images/notification.png and /dev/null differ diff --git a/web/server/vue-cli/src/assets/userguide/images/products.png b/web/server/vue-cli/src/assets/userguide/images/products.png deleted file mode 100644 index 72ffeae040..0000000000 Binary files a/web/server/vue-cli/src/assets/userguide/images/products.png and /dev/null differ diff --git a/web/server/vue-cli/src/assets/userguide/images/products/disable_review_status_change.png b/web/server/vue-cli/src/assets/userguide/images/products/disable_review_status_change.png new file mode 100644 index 0000000000..f8067cef22 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/products/disable_review_status_change.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/products/edit_announcement_btn.png b/web/server/vue-cli/src/assets/userguide/images/products/edit_announcement_btn.png new file mode 100644 index 0000000000..732f85e67a Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/products/edit_announcement_btn.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/edit_product.png b/web/server/vue-cli/src/assets/userguide/images/products/edit_product.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/edit_product.png rename to web/server/vue-cli/src/assets/userguide/images/products/edit_product.png diff --git a/web/server/vue-cli/src/assets/userguide/images/products/new_product.png b/web/server/vue-cli/src/assets/userguide/images/products/new_product.png new file mode 100644 index 0000000000..f7a22cadf1 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/products/new_product.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/products/no_permission.png b/web/server/vue-cli/src/assets/userguide/images/products/no_permission.png new file mode 100644 index 0000000000..5166db1f34 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/products/no_permission.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/notificaiton_dialog.png b/web/server/vue-cli/src/assets/userguide/images/products/notificaiton_dialog.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/notificaiton_dialog.png rename to web/server/vue-cli/src/assets/userguide/images/products/notificaiton_dialog.png diff --git a/web/server/vue-cli/src/assets/userguide/images/products/notification.png b/web/server/vue-cli/src/assets/userguide/images/products/notification.png new file mode 100644 index 0000000000..9416bfcd52 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/products/notification.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/product_permissions.png b/web/server/vue-cli/src/assets/userguide/images/products/product_permissions.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/product_permissions.png rename to web/server/vue-cli/src/assets/userguide/images/products/product_permissions.png diff --git a/web/server/vue-cli/src/assets/userguide/images/products/products.png b/web/server/vue-cli/src/assets/userguide/images/products/products.png new file mode 100644 index 0000000000..6c15dde580 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/products/products.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/remove_product.png b/web/server/vue-cli/src/assets/userguide/images/products/remove_product.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/remove_product.png rename to web/server/vue-cli/src/assets/userguide/images/products/remove_product.png diff --git a/web/server/vue-cli/src/assets/userguide/images/bug_path.png b/web/server/vue-cli/src/assets/userguide/images/report/bug_path.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/bug_path.png rename to web/server/vue-cli/src/assets/userguide/images/report/bug_path.png diff --git a/web/server/vue-cli/src/assets/userguide/images/report/button_pane.png b/web/server/vue-cli/src/assets/userguide/images/report/button_pane.png new file mode 100644 index 0000000000..b2d803458a Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/report/button_pane.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/checker_documentation.png b/web/server/vue-cli/src/assets/userguide/images/report/checker_documentation.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/checker_documentation.png rename to web/server/vue-cli/src/assets/userguide/images/report/checker_documentation.png diff --git a/web/server/vue-cli/src/assets/userguide/images/comment.png b/web/server/vue-cli/src/assets/userguide/images/report/comment.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/comment.png rename to web/server/vue-cli/src/assets/userguide/images/report/comment.png diff --git a/web/server/vue-cli/src/assets/userguide/images/report_navigation_tree.png b/web/server/vue-cli/src/assets/userguide/images/report/report_navigation_tree.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/report_navigation_tree.png rename to web/server/vue-cli/src/assets/userguide/images/report/report_navigation_tree.png diff --git a/web/server/vue-cli/src/assets/userguide/images/review_status_change.png b/web/server/vue-cli/src/assets/userguide/images/report/review_status_change.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/review_status_change.png rename to web/server/vue-cli/src/assets/userguide/images/report/review_status_change.png diff --git a/web/server/vue-cli/src/assets/userguide/images/review_status_message.png b/web/server/vue-cli/src/assets/userguide/images/report/review_status_message.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/review_status_message.png rename to web/server/vue-cli/src/assets/userguide/images/report/review_status_message.png diff --git a/web/server/vue-cli/src/assets/userguide/images/review_status_unreviewed.png b/web/server/vue-cli/src/assets/userguide/images/report/review_status_unreviewed.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/review_status_unreviewed.png rename to web/server/vue-cli/src/assets/userguide/images/report/review_status_unreviewed.png diff --git a/web/server/vue-cli/src/assets/userguide/images/same_reports.png b/web/server/vue-cli/src/assets/userguide/images/report/same_reports.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/same_reports.png rename to web/server/vue-cli/src/assets/userguide/images/report/same_reports.png diff --git a/web/server/vue-cli/src/assets/userguide/images/report_view.png b/web/server/vue-cli/src/assets/userguide/images/report_view.png deleted file mode 100644 index 3787e74fc8..0000000000 Binary files a/web/server/vue-cli/src/assets/userguide/images/report_view.png and /dev/null differ diff --git a/web/server/vue-cli/src/assets/userguide/images/reports.png b/web/server/vue-cli/src/assets/userguide/images/reports.png deleted file mode 100644 index df04d84efd..0000000000 Binary files a/web/server/vue-cli/src/assets/userguide/images/reports.png and /dev/null differ diff --git a/web/server/vue-cli/src/assets/userguide/images/clear_all_filters.png b/web/server/vue-cli/src/assets/userguide/images/reports/clear_all_filters.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/clear_all_filters.png rename to web/server/vue-cli/src/assets/userguide/images/reports/clear_all_filters.png diff --git a/web/server/vue-cli/src/assets/userguide/images/clear_report_filters.png b/web/server/vue-cli/src/assets/userguide/images/reports/clear_report_filters.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/clear_report_filters.png rename to web/server/vue-cli/src/assets/userguide/images/reports/clear_report_filters.png diff --git a/web/server/vue-cli/src/assets/userguide/images/reports/compare_runs.png b/web/server/vue-cli/src/assets/userguide/images/reports/compare_runs.png new file mode 100644 index 0000000000..e5903fa592 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/reports/compare_runs.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/reports/compare_tags.png b/web/server/vue-cli/src/assets/userguide/images/reports/compare_tags.png new file mode 100644 index 0000000000..54d5971839 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/reports/compare_tags.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/detection_status_flow_chart.png b/web/server/vue-cli/src/assets/userguide/images/reports/detection_status_flow_chart.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/detection_status_flow_chart.png rename to web/server/vue-cli/src/assets/userguide/images/reports/detection_status_flow_chart.png diff --git a/web/server/vue-cli/src/assets/userguide/images/detection_status_flow_chart.svg b/web/server/vue-cli/src/assets/userguide/images/reports/detection_status_flow_chart.svg similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/detection_status_flow_chart.svg rename to web/server/vue-cli/src/assets/userguide/images/reports/detection_status_flow_chart.svg diff --git a/web/server/vue-cli/src/assets/userguide/images/reports/detection_statuses.png b/web/server/vue-cli/src/assets/userguide/images/reports/detection_statuses.png new file mode 100644 index 0000000000..72b2122e94 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/reports/detection_statuses.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/reports/filter_runs.png b/web/server/vue-cli/src/assets/userguide/images/reports/filter_runs.png new file mode 100644 index 0000000000..e92d0194b6 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/reports/filter_runs.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/reports/filters.png b/web/server/vue-cli/src/assets/userguide/images/reports/filters.png new file mode 100644 index 0000000000..aa225bf0d8 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/reports/filters.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/list_of_source_components.png b/web/server/vue-cli/src/assets/userguide/images/reports/list_of_source_components.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/list_of_source_components.png rename to web/server/vue-cli/src/assets/userguide/images/reports/list_of_source_components.png diff --git a/web/server/vue-cli/src/assets/userguide/images/reports/manage_source_components.png b/web/server/vue-cli/src/assets/userguide/images/reports/manage_source_components.png new file mode 100644 index 0000000000..2f5afec348 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/reports/manage_source_components.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/remove_filtered_reports.png b/web/server/vue-cli/src/assets/userguide/images/reports/remove_filtered_reports.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/remove_filtered_reports.png rename to web/server/vue-cli/src/assets/userguide/images/reports/remove_filtered_reports.png diff --git a/web/server/vue-cli/src/assets/userguide/images/reports/reports.png b/web/server/vue-cli/src/assets/userguide/images/reports/reports.png new file mode 100644 index 0000000000..f53ceceab4 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/reports/reports.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/reports/review_statuses.png b/web/server/vue-cli/src/assets/userguide/images/reports/review_statuses.png new file mode 100644 index 0000000000..82c48e77b0 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/reports/review_statuses.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/reports/severity_levels.png b/web/server/vue-cli/src/assets/userguide/images/reports/severity_levels.png new file mode 100644 index 0000000000..c251997a98 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/reports/severity_levels.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/unqiue_reports.png b/web/server/vue-cli/src/assets/userguide/images/reports/unqiue_reports.png similarity index 100% rename from web/server/vue-cli/src/assets/userguide/images/unqiue_reports.png rename to web/server/vue-cli/src/assets/userguide/images/reports/unqiue_reports.png diff --git a/web/server/vue-cli/src/assets/userguide/images/run_diff.png b/web/server/vue-cli/src/assets/userguide/images/run_diff.png deleted file mode 100644 index 1a378ff082..0000000000 Binary files a/web/server/vue-cli/src/assets/userguide/images/run_diff.png and /dev/null differ diff --git a/web/server/vue-cli/src/assets/userguide/images/run_history.png b/web/server/vue-cli/src/assets/userguide/images/run_history.png deleted file mode 100644 index 39be24365e..0000000000 Binary files a/web/server/vue-cli/src/assets/userguide/images/run_history.png and /dev/null differ diff --git a/web/server/vue-cli/src/assets/userguide/images/run_tag_diff.png b/web/server/vue-cli/src/assets/userguide/images/run_tag_diff.png deleted file mode 100644 index b4c6418cbc..0000000000 Binary files a/web/server/vue-cli/src/assets/userguide/images/run_tag_diff.png and /dev/null differ diff --git a/web/server/vue-cli/src/assets/userguide/images/runs.png b/web/server/vue-cli/src/assets/userguide/images/runs.png deleted file mode 100644 index 5271419476..0000000000 Binary files a/web/server/vue-cli/src/assets/userguide/images/runs.png and /dev/null differ diff --git a/web/server/vue-cli/src/assets/userguide/images/runs/analyzer_statistics.png b/web/server/vue-cli/src/assets/userguide/images/runs/analyzer_statistics.png new file mode 100644 index 0000000000..4645b02317 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/runs/analyzer_statistics.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/runs/check_command.png b/web/server/vue-cli/src/assets/userguide/images/runs/check_command.png new file mode 100644 index 0000000000..e1d9e956b8 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/runs/check_command.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/runs/compare_runs.png b/web/server/vue-cli/src/assets/userguide/images/runs/compare_runs.png new file mode 100644 index 0000000000..bdbacdfc2a Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/runs/compare_runs.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/runs/delete_runs.png b/web/server/vue-cli/src/assets/userguide/images/runs/delete_runs.png new file mode 100644 index 0000000000..ef197cd2d7 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/runs/delete_runs.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/runs/filter_run_history_events.png b/web/server/vue-cli/src/assets/userguide/images/runs/filter_run_history_events.png new file mode 100644 index 0000000000..41a06deff7 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/runs/filter_run_history_events.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/runs/filter_runs.png b/web/server/vue-cli/src/assets/userguide/images/runs/filter_runs.png new file mode 100644 index 0000000000..3eda39ac7e Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/runs/filter_runs.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/runs/runs.png b/web/server/vue-cli/src/assets/userguide/images/runs/runs.png new file mode 100644 index 0000000000..9f7c786416 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/runs/runs.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/runs/show_analyzer_statistics_btn.png b/web/server/vue-cli/src/assets/userguide/images/runs/show_analyzer_statistics_btn.png new file mode 100644 index 0000000000..646f6ca029 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/runs/show_analyzer_statistics_btn.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/runs/show_check_command_btn.png b/web/server/vue-cli/src/assets/userguide/images/runs/show_check_command_btn.png new file mode 100644 index 0000000000..66f2afe438 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/runs/show_check_command_btn.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/runs/show_description.png b/web/server/vue-cli/src/assets/userguide/images/runs/show_description.png new file mode 100644 index 0000000000..0e47dd9010 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/runs/show_description.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/runs/show_run_history.png b/web/server/vue-cli/src/assets/userguide/images/runs/show_run_history.png new file mode 100644 index 0000000000..4b087b7e3e Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/runs/show_run_history.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/runs/sort_runs.png b/web/server/vue-cli/src/assets/userguide/images/runs/sort_runs.png new file mode 100644 index 0000000000..39729760eb Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/runs/sort_runs.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/statistics/checker_statistics.png b/web/server/vue-cli/src/assets/userguide/images/statistics/checker_statistics.png new file mode 100644 index 0000000000..e871d9ed30 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/statistics/checker_statistics.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/statistics/component_statistics.png b/web/server/vue-cli/src/assets/userguide/images/statistics/component_statistics.png new file mode 100644 index 0000000000..00a7be4a7b Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/statistics/component_statistics.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/statistics/component_statistics_expanded.png b/web/server/vue-cli/src/assets/userguide/images/statistics/component_statistics_expanded.png new file mode 100644 index 0000000000..65b7ab927c Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/statistics/component_statistics_expanded.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/statistics/product_overview.png b/web/server/vue-cli/src/assets/userguide/images/statistics/product_overview.png new file mode 100644 index 0000000000..77c796844e Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/statistics/product_overview.png differ diff --git a/web/server/vue-cli/src/assets/userguide/images/statistics/severity_statistics.png b/web/server/vue-cli/src/assets/userguide/images/statistics/severity_statistics.png new file mode 100644 index 0000000000..4fb8c6b4f3 Binary files /dev/null and b/web/server/vue-cli/src/assets/userguide/images/statistics/severity_statistics.png differ diff --git a/web/server/vue-cli/src/assets/userguide/userguide.md b/web/server/vue-cli/src/assets/userguide/userguide.md index fb949707d8..dc67fa2810 100644 --- a/web/server/vue-cli/src/assets/userguide/userguide.md +++ b/web/server/vue-cli/src/assets/userguide/userguide.md @@ -1,290 +1,380 @@ -User Guide -========== +WEB GUI User Guide +================== **CodeChecker** is a static analysis infrastructure built on the [LLVM/Clang -Static Analyzer](http://clang-analyzer.llvm.org) toolchain, alternative tool for -[`scan-build`](http://clang-analyzer.llvm.org/scan-build.html) in a Linux or -macOS (OS X) development environment. +Static Analyzer](http://clang-analyzer.llvm.org) toolchain, alternative tool +for [`scan-build`](http://clang-analyzer.llvm.org/scan-build.html) in a Linux +or macOS (OS X) development environment.
More descriptions and guides available - + on GitHub
Table of Contents ================= -* [Products](#userguide-products) - * [Managing products](#userguide-managing-products) - * [Disable review status change](#userguide-disable-review-status-change) - * [Remove a product](#userguide-remove-product) - * [Managing permissions](#userguide-managing-permissions) -* [List of runs](#userguide-list-of-runs) - * [Filter runs](#userguide-filter-runs) - * [Compare runs](#userguide-compare-runs) - * [Delete runs](#userguide-delete-runs) - * [Sorting runs](#userguide-sorting-runs) -* [Checker statistics](#userguide-checker-statistics) - * [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) - * [Compare two different runs](#userguide-diff-runs) - * [Compare two different tagged versions of the same](#userguide-diff-tags) - * [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) - * [Show documentation](#userguide-show-documentation) - * [Change review status](#userguide-change-review-status) - * [Same reports](#userguide-same-reports) - * [Bug path view](#userguide-bug-path-view) - * [Comment](#userguide-comment) -* [Run history](#userguide-run-history) -* [Server configuration](#userguide-server-config) - * [Notification banner](#userguide-notification) - -# Products -The product system allows a single CodeChecker server to serve multiple separate -result databases, named "products", under the same IP address and authentication -domain. - -## Managing products -![Products](images/products.png) - -Click *Add new product*, then fill the form presented. The values that need to -be filled here are the same as the arguments for -`CodeChecker cmd products add`. These buttons are visible only for -*Super Users*. - -![New product](images/new_product.png) +* [Products](#products) + * [Managing products](#managing-products) + * [Add new product](#add-new-product) + * [Disable review status change](#disable-review-status-change) + * [Edit product configuration](#edit-product-configuration) + * [Remove a product](#remove-a-product) + * [Managing permissions](#managing-permissions) + * [Notification banner](#notification-banner) +* [Runs and history events](#runs-and-history-events) + * [Runs](#runs) + * [Show description](#show-description) + * [Show check command](#show-check-command) + * [Show analyzer statistics](#show-analyzer-statistics) + * [Filter runs](#filter-runs) + * [Compare runs](#compare-runs) + * [Sorting runs](#sorting-runs) + * [Delete runs](#delete-runs) + * [Run history](#run-history) + * [Compare run history events](#compare-run-history-events) + * [Filter run history events](#filter-run-history-events) +* [Reports](#reports) + * [Review status](#review-status) + * [Detection status](#detection-status) + * [Severity levels](#severity-levels) + * [Filtering reports](#filtering-reports) + * [Date filters](#date-filters) + * [Regex based filters](#regex-based-filters) + * [Report count](#report-count) + * [Remove filtered reports](#remove-filtered-reports) + * [Clear report filters](#clear-report-filters) + * [Unique reports](#unique-reports) + * [Compare mode](#compare-mode) + * [Compare two different runs](#compare-runs) + * [Compare two different tagged versions of the same](#compare-tags) + * [Manage source components](#manage-source-components) +* [Report details](#report-details) + * [Report navigation tree](#report-navigation-tree) + * [Button pane](#button-pane) + * [Report info](#report-info) + * [Show documentation](#show-documentation) + * [Change review status](#change-review-status) + * [Same reports](#same-reports) + * [Bug path view](#bug-path-view) + * [Comment](#comment) +* [Statistics](#statistics) + * [Statistics pages](#statistics-pages) + * [Product overview](#product-overview) + * [Checker statistics](#checker-statistics) + * [Severity statistics](#severity-statistics) + * [Component statistics](#component-statistics) + * [Filtering statistics](#filtering-statistics) + * [Uniqueing checker statistics](#checker-statistics-uniqueing) + +# Products +The product system allows a single CodeChecker server to serve multiple +separate result databases, named `products`, under the same IP address and +authentication domain. Each product can be configured to use a separate +database and the access control can be configured separately for each product +by product administrators. + +Most of the time a product represents a single GIT repository. For example we +can create separate CodeChecker products for +[postgresql](https://github.com/postgres/postgres), +[curl](https://github.com/curl/curl), +[bitcoin](https://github.com/bitcoin/bitcoin) or +[openssl](https://github.com/openssl/openssl) repositories. + +**Note**: comparison and statistics features can be used inside one product and +not between multiple products. + +![Products](images/products/products.png) + +In the product list table you can see the following information: +- `Product name`: display name of the product. +- `Description`: short description of the product. +- `Administrator names`: product admins have the right to allow access for +individual people or LDAP groups. +- `Number of runs`: number of runs in the product. +- `Latest store to the product`: date of the latest run storage. +- `Run store in progress`: show run names if a storage is in progress. +- `Action buttons` (only for ADMINS): action buttons to edit and remove +products. + +**Note**: if you don't have permission for a product and you see the following +message, ask permission from a product admin: + +![Products](images/products/no_permission.png) + +## Managing products +### Add new product +Click to the *NEW PRODUCT* button above the product list table, then fill the +form presented. The values that need to be filled here are the same as the +arguments for `CodeChecker cmd products add`. + +**NOTE**: only users with `Super Users` access can add a new product. + +![New product](images/products/new_product.png) If the product creation is successful, the window will disappear and the product will appear in the product list. -Editing a product is done through the pencil icon. This window lets you edit -the product's configuration. - -![Edit product](images/edit_product.png) - -### Disable review status change +#### Disable review status change Review status change can be disabled on the WEB UI to force programmers to use inline source code comments. This can be configured on the product editing window by administrators of a product. -### Remove a product -Products can be deleted by clicking on the red trash bin. This way the product -is only unmounted from the server (losing access control data and connection), -but **no analysis results are deleted**. +![Disable review status change](images/products/disable_review_status_change.png) + +### Edit product configuration +Editing a product configuration is done through the pencil icon which can be +found in the latest *Actions* column of the product list table. + +![Edit product](images/products/edit_product.png) + +### Remove a product +Products can be deleted by clicking on the red trash bin in the *Actions* +column of the product list table. This way the product is only unmounted from +the server (losing access control data and connection), but +**no analysis results are deleted**. Database needs to be deleted separately. -![Remove product](images/remove_product.png) +![Remove product](images/products/remove_product.png) -## Managing permissions -* Server-wide permissions can be edited by clicking *Edit global permissions*. -* Product-level permissions can be edited by clicking the edit icon for the -product you want to configure the permissions. +## Managing permissions +* Server-wide permissions can be edited by clicking *EDIT GLOBAL PERMISSION* +button above the product list page. Only users with `Super Users` access can +edit global permissions. +* Product-level permissions can be edited by clicking the edit icon +(blue pencil) for the product you want to configure the permissions. The two lists show the users and groups known to the system - if a tick is present in its row, the given user or group has the permission directly granted. (Users who only have a certain permission through permission inheritance are not shown with a tick.) -![Product permissions](images/product_permissions.png) +![Product permissions](images/products/product_permissions.png) Only the permissions you have rights to manage are shown. You can edit multiple permissions opening the window only once. Simply tick or untick the users/groups you want to give the permission to or revoke from them. -Clicking *OK* will save the changes to the database. - -# List of runs -List page contains the analysis runs available on the server under the selected -product. - -You can do the following on this page: -- [Filter runs](#userguide-filtering). -- [Compare analysis](#userguide-compare-runs). -- [Delete runs](#userguide-delete-runs). -- [Sorting runs](#userguide-sorting-runs). - -![Runs](images/runs.png) - - -The meaning of the table columns: -- **Diff** - In this column you can select two runs (*baseline* and -*compared to*) which will be compared to each other by click on the *Diff* -button. -- **Name** - Name of the run. -- **Number of unresolved reports** - Number of non unique reports excluding -*Resolved*, *False positive* and *Intentional* reports. -- **Storage date** - Storage date of the runs. -- **Analysis duration** - Duration of the analysis. -- **Check command** - By clicking on *Show* text the check command will be shown -in a pop-up window. -- **Detection status** - Detection statuses are calculated based on the detection -status values from the previous store where the reports are stored again with -the same run name. When storing the results of a run from scratch then each -report will have detection status of *New*. -- **Version tag** - Latest version tag of the run. -- **Delete** - In this column you can select multiple runs which will be removed -by clicking on the *Delete* button. - -## Filter runs -You can filter runs by run name using the input box above the run list table. -The filter is **case insensitive** and doing a **substring matching**. If we -start typing some phrase in this input box, the list are being _filtered -automatically_. - -## Compare runs -Calculates difference between two analyses of the project, showing which bugs -have been fixed and which are newly introduced. - -## Delete runs -You can delete multiple runs by selecting them and clicking on the Delete -button. It will remove the run and all related data from the database. - -## Sorting runs -It is possible to change the order of the runs by clicking on a cell at header -of the run list table. For example, you can sort the run list by the number of -bugs or the run name. - -# Checker statistics -A statistical overview can be seen under "Checker statistics" panel. -Here you can see multiple tables: -- **Checker statistics** table shows the number of reports by checkers based on -some attributes of the report like severity, and report status. -- **Severity statistics** table shows the number of report by severity levels. - - -![Checker statistics](images/checker_statistics.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 -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 -to this page. This page lists the analysis result for the given run. - -![Reports](images/reports.png) - -## Filtering -When opening the bug list view under "All reports" tab or by clicking a specific -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 -"runs" view this field is filled by default. In "All reports" tab no run is -selected in which case the reports from all runs are visible. - - **Run tag** - When runs are stored in update mode (i.e. on the same run -name), then the specific runs can be tagged in order to be easier to identify -them. By this field you can select the reports found during a specific run -event. -- [**Compare to**](#userguide-diff-mode) - - **Run name** - Here you can select multiple run name which you want to -compare against the baseline filter set. - - **Run tag** - Here you can select multiple run tags which you want to -compare against the baseline filter set. - - **Diff type** - Here you can set if you'd like to see the bugs which appear -only in the **Baseline**, **Compare to** or both. -- [**Review status**](#userguide-review-status) - You can select the reports -with the given review status to check only *False positive*, *Unreviewed*, etc. -reports. -- [**Detection status**](#userguide-detection-status) - You can select the -reports with the given detection status to check only *Unresolved*, *Resolved*, -etc. reports. -- [**Severity**](#userguide-severity-levels) - The nature of the bugs is sorted -in different severity levels. For example, a division by zero or a null pointer -dereference is more serious than an unused variable. By this field you can -select the reports on the given severity levels. -- **Bug path length** - A bug path length interval can restrict the list of -displayed bug reports. In these fields you can choose the minimum and maximum -values of bug path length. -- **Detection date** - A date interval can also restrict the list of displayed -bug reports. In this field you can choose the date of detection or fixing. -- **File path**: You can choose a set of files to restrict the list of bug -reports. -- [**Source component**](https://github.com/Ericsson/codechecker/blob/master/docs/web/user_guide.md#source-components) - -Here you can select multiple source components which are named collection of -directories specified as directory filter. -- **Checker name** - If you are interested in specific type of bugs then here -you can choose them. -- **Checker message** - The static analysis tools provide a message to indicate -the reason of a specific bug. This message is also filterable. - -Run name may contain `*` quantifiers which matches any number of characters -(zero or more). So if you have `run_1_a_name`, `run_2_b_name`, `run_2_c_name`, -`run_3_d_name` then `run_2*` will select `run_2_b_name` and `run_2_c_name`. - -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 bottom 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) +Clicking *SAVE* will save the changes to the database. -### 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 -the top of the filter bar. +## Notification banner +There is an option to set a global notification text, that will show on top of +every page below the header bar. -![Clear all filters](images/clear_all_filters.png) +![Notification](images/products/notification.png) -![Clear report filters](images/clear_report_filters.png) +You can edit this alert on the products page with `EDIT ANNOUNCEMENT` button, +but **Super User** permissions are necessary. -### Unique reports -At the top of the filter panel there is a "Unique reports" checkbox. This -narrows the report list to unique bug. The same bug may appear several times if -it is found on different control paths, i.e. through different function calls or -in multiple runs. By checking "Unique reports" a report appears only once even -if it is found on several paths. +![Products](images/products/edit_announcement_btn.png) -![Unique reports](images/unqiue_reports.png) +You can remove the current notification by saving an empty text. -## Diff mode -In diff mode you can calculate the difference between multiple analyses of the -project, showing which bugs have been fixed and which are newly introduced or -which can be fined in all runs. +![Notification Dialog](images/products/notificaiton_dialog.png) -At the **Baseline** filter section you can select the run names and run tags -against which you want to check the difference. +# Runs and history events +## Runs +A run represents subsequent analysis activities for the same source code with +the same analysis settings (checker configurations). We are storing analysis +results to a run within a product: -At the **Compare to** filter section you can select the run names and run tags -which you want to compare against the *Baseline* runs and run tags. +```sh +CodeChecker store \ + --name master_xerces \ + --url https://my.codechecker.server.com/xerces + ./reports +``` -### Compare two different runs -![Compare two different runs](images/run_diff.png) +![Runs](images/runs/runs.png) -### Compare two different tagged versions of the same -![Compare two different tagged versions of the same](images/run_tag_diff.png) +This page contains the analysis runs available on the server under the selected +product. -## Review status +Each run has the following fields/columns: +- `Delete`: in the first column of the run list table you can select multiple +runs which will be removed by clicking on the *DELETE* button. For more +information [see](#delete-runs). +- `Unique name` which identifies a run. If an already existing run name is +used during the storage, the run will be updated: a new history event will +be created for the run and the detection status will be changed for each +report. + - `Version tag` (optional): a unique identifier for this individual store of +results in the run's history. + - `Description` (optional): a custom textual description to be shown alongside +the run. You can find more information how to see the description +[here](#show-description). + - `Check command` which was used to analyze your project. You can find more + information how to see the check command [here](#show-check-command). + - `Detection status counts`: show the number of reports distributed by + detection statuses. +- `Number of unresolved reports`: number of non unique reports excluding +*Resolved*, *False positive* and *Intentional* reports. +- `Analyzer statistics`: information about the analysis. You can find more +information how to see the analysis statistics +[here](#show-analyzer-statistics). +- `Latest storage date`: latest storage/update date of the run. +- `Analysis duration`: the length of the analysis. +- `CodeChecker version` which was used during the analysis. +- `Diff`: in this column you can select two runs (*baseline* and +*compared to*) which will be compared to each other by click on the *DIFF* +button. For more information [see](#compare-runs). + +### Show description +Description is a custom textual description to be shown alongside the run and +given by the `CodeChecker store` command: +```sh +CodeChecker store \ + --name xerces \ + --description "Analysis results of the Xerces-C++ project." \ + --url https://my.codechecker.server.com/xerces \ + ./reports +``` + +Click on the [i] button beside the run name to show the description. + +![Show description](images/runs/show_description.png) + +### Show check command +Check/Analyze command is the command which was used to analyze your project: +```sh +CodeChecker analyze \ + -o ./reports \ + -e sensitive \ + ./compilation_database.json +``` + +Click on the console button under the run name to show the check command. + +![Show check command](images/runs/show_check_command_btn.png) + +![Check command](images/runs/check_command.png) + +### Show analyzer statistics +Analyzer statistics show the following information for each analyzer +(Clang Static Analyzer, Clang Tidy): +- Analyzer version. +- Number of successfully analyzed files. +- Number of files which failed to analyze. +- List of files which failed to analyze. + +Click on the *Analyzer statistics column* to show analyzer statistics for a +run. +![Show analyzer statistics](images/runs/show_analyzer_statistics_btn.png) + +![Analyzer statistics](images/runs/analyzer_statistics.png) + +Note that analysis failure may come with incomplete results. Possible reasons +of analysis failure are gcc/clang incompatibility (thus compilation error), +analyzer runtime crash, etc. + +### Filter runs +You can filter runs by run name using the input box above the run list table. +The filter is **case insensitive** and does a **substring matching**. If we +start typing some phrase in this input box, the list are being +*filtered automatically*. + +![Filter runs](images/runs/filter_runs.png) + +**NOTE**: +- other filters in beside the run name filter can be used to filter +run history events. +- filters will be saved in the URL query parameter list. + +### Compare runs +Calculates the difference between two analyses of the project, showing which +reports have been fixed and which are newly introduced. + +To compare analysis results you have to do the following: +- select *BASELINE** runs with the first checkbox in the *Diff* column of the +run list table. +- select *COMPARE TO** runs with the second checkbox in the *Diff* column of +the run list table. +- click on the `Diff` button above the run list table. + +![Compare runs](images/runs/compare_runs.png) + +### Sorting runs +It is possible to change the order of the runs by clicking on a cell at the +header of the run list table. For example, you can sort the run list by the +storage date or the run name. + +![Sort runs](images/runs/sort_runs.png) + +### Delete runs +You can delete multiple runs by selecting them with the checkboxes in the first +column of the run list table and clicking on the `DELETE` button above the run +list table. It will remove the run and all related data from the database. + +![Delete runs](images/runs/delete_runs.png) + +**IMPORTANT**: be careful when you delete a run because this operation can not +be undone. + +## Run history +On every run storage event a history event is created for the run. You can +see the history events for a run if you click to the expand arrow (`v` icon) +beside the run name column. + +You will see the following information for each history event: +- `Storage date` when the run was stored to the server. +- `User name` who performed the `CodeChecker store` operation. +- `Show statistics` button which can be used to show the statistics for this +history event. +- `Check command` which was used to analyze your project. You can click to the +console style button (`>_` icon) to see the actual check command of the +history event. +- `CodeChecker version` which was used during the analysis. +- `Analyzer statistics`: information about the analysis. You can click to this +section to see the details. + +![Run history](images/runs/show_run_history.png) + +### Compare run history events +Calculates difference between two analyses of the same run storage, showing +which reports have been fixed and which are newly introduced. + +To compare analysis history events you have to do the following: +- select *BASELINE** runs with the first checkbox in the *Diff* column of the +run list table for a history event. +- select *COMPARE TO** runs with the second checkbox in the *Diff* column of +the run list table for a history event. +- click on the `Diff` button above the run list table. + +### Filter run history events +You can filter run history events with the tag name and storage date input +boxes above the run list table. + +![Filter run history events](images/runs/filter_run_history_events.png) + +*Note*: the filters will be saved in the URL query parameter list. + +# Reports +If you select a run at the [list of runs](#runs) view, you get to this page. +This page lists the analysis result for the given run. + +![Reports](images/reports/reports.png) + +Every report has the following fields: +- `Unique report identifier` (repot hash). You can find more information how +these hashes are generated [here](https://github.com/Ericsson/codechecker/blob/master/docs/analyzer/report_identification.md). +- `File path`: file path where the report is found. +- `Line and column numbers` of the report where the bug is. +- `Checker name` which found the report during the analysis. +- `Checker message`: description about the report. +- `Analyzer name` which found the problem during the analysis. +- [`Severity`](#severity-levels) +- `Bug path length`: length of the bug path. Reports with longer bug path +are more difficult to understand. +- [`Latest review status`](#review-status) +- [`Latest detection status`](#detection-status). This column is visible only +when uniqueing is disabled. +- `Detection date`: the storage date when the report was stored to the server +for the first time. This field is visible only when you hover your mouse over +the *Detection status* icon. +- `Fix date`: storage date when the report is dissapeared from a run update. +This field is visible only when you hover your mouse over the +*Detection status* icon. + +## Review status Reports can be assigned a review status of the following values: - **Unreviewed** (_default_): Nobody has seen this report. @@ -296,6 +386,9 @@ you should read the [false positive how to](https://github.com/Ericsson/codechec - **Intentional**: This report is a bug but we don't want to fix it. +![Review statuses](images/reports/review_statuses.png) + + Review statuses are connected to [report hashes](https://github.com/Ericsson/codechecker/blob/master/docs/analyzer/report_identification.md). If the same report can be found in multiple runs it will have the same review @@ -308,12 +401,13 @@ It can be changed on the [GUI](#userguide-change-review-status) or by using **Note**: source code comment is stronger and can overwrite the value in the database. -## Detection status +## Detection status The detection status is the state of a bug report in a run. - The detection status of a report is connected to the **report ID**. It means that every report has a separate detection status. -- It will be *calculated automatically* by the server on run storage events. +- It will be *calculated automatically* by the server on run storage events +based on the reports in the last storage and the current storage. - Changing the review status by using source code comments will not affect the detection status change. @@ -334,133 +428,356 @@ stored. were reported by a checker that does not exists anymore because it was removed or renamed. +![Detection statuses](images/reports/detection_statuses.png) + The diagram below shows the detection status transition which may happen when storing results to the server. For example if the detection status of a report in the database is **New** the server will change it to **Unresolved**, **Resolved**, **Off** or **Unavailable** based on the conditions above. -![Detection status change](images/detection_status_flow_chart.png) +![Detection status change](images/reports/detection_status_flow_chart.png) -## Severity levels +## Severity levels We are mapping checker names to different severity levels: -- **Unspecified** -- **Style**: -(E.g. _modernize-raw-string-literal, modernize-use-auto, etc._) -- **Low** -(E.g. _deadcode.DeadStores, misc-unused-parameters, etc._) -- **Medium**: -(E.g. _unix.Malloc, core.uninitialized.Assign, etc._) +- **Critical**: +clang-diagnostic-error (compilation error and the analysis was not successful). - **High**: -(E.g. _core.DivideZero, core.NullDereference, cplusplus.NewDelete, etc._) -- **Critical** +*core.DivideZero*, *core.NullDereference*, *cplusplus.NewDelete*, etc. +- **Medium**: +*unix.Malloc*, *core.uninitialized.Assign*, etc. +- **Low** +*deadcode.DeadStores*, *misc-unused-parameters*, etc. +- **Style**: +*modernize-raw-string-literal*, *modernize-use-auto*, etc. +- **Unspecified**: +*android-cloexec-dup*, etc. -## Manage source components -Source components are named collections of directory filters. Source components +![Severity levels](images/reports/severity_levels.png) + +## Filtering reports +When opening the Reports list view on the left sidebar you will see the +following: + +![Report filters](images/reports/filters.png) + +The following filter options are available: +- [`Unique reports`](#unique-reports) - You can uniqueing the reports by +checking this. For more information click [here](#unique-reports). +- **Baseline** + - `Run / Tag Filter` - You can select one or more run names with tags. The + result list is restricted on the findings in these runs/tags. By selecting a + specific run in the *runs* view this field is filled by default. + When runs are stored in update mode (i.e. on the same run name), then the + specific runs can be tagged in order to be easier to identify them. By this + field you can also select the reports found during a specific run event. For + this you can use the cogwheel button beside each run after hovering on the + run to specify a tag. + - `Outstanding reports on a given date` - Filter reports that were + DETECTED BEFORE the given date and NOT FIXED BEFORE the given + date. +- [**Compare to**](#diff-mode) + - `Run / Tag Filter` - Here you can select multiple runs / tags which you + want to compare against the baseline filter set. + - `Outstanding reports on a given date` - Here you can select date which + you want to compare against the baseline filter set. + - `Diff type` - Here you can set if you'd like to see the reports which + appear only in the **Baseline**, **Compare to** or both. +- `File path`: You can choose a set of files to restrict the list of bug +reports. +- `Checker name` - If you are interested in specific type of bugs then here +you can choose them. +- [`Severity`](#severity-levels) - The nature of the reports is sorted +in different severity levels. For example, a division by zero or a null pointer +dereference is more serious than an unused variable. By this field you can +select the reports on the given severity levels. +- [`Latest Review Status`](#review-status) - You can select the reports +with the given review status to check only *False positive*, *Unreviewed*, etc. +reports. +- [`Latest Detection Status`](#detection-status) - You can select the +reports with the given detection status to check only *Unresolved*, *Resolved*, +etc. reports. +- `Analyzer name` - If you are interested in specific type of reports which +were detected by an analyzer (Clang Tidy, CppCheck etc.) then here you can +choose them. +- [`Source component`](https://github.com/Ericsson/codechecker/blob/master/docs/web/user_guide.md#source-components) - +Here you can select multiple source components which are named collections of +directories specified as directory filter. +- `Checker message` - The static analysis tools provide a message to indicate +the reason of a specific bug. This message is also filterable. +- **Dates** + - `Detection date` - Filter reports that were detected between the given + interval. + - `Fix date` - Filter reports that were fixed between the given interval. +- `Report hash` - Every report has a unique (hash) identifier called Report +Identifier which can be filtered by using this input box. +- `Bug path length` - A bug path length interval can restrict the list of +displayed bug reports. In these fields you can choose the minimum and maximum +values of bug path length. + +Every filter is collapsed by default to save more space in the UI. To expand +the filter and see the selected filter items you can click on the down arrow +(`v` icon) beside each filter name. + +### Date filters +Every report has a detection date and a fix date. +- `Detection date`: the storage date when the report was stored to the server +for the first time. +- `Fix date`: storage date when the report is dissapeared from a run update. + +Available date filters: +- `Detection date`: get results which were detected between the given dates. +- `Fix date`: get results which were fixed between the given dates. +- `Outstanding reports on a given date`: get results which were +DETECTED BEFORE the given date and NOT FIXED BEFORE the given +date. + +### Regex based filters +At `Run / Tag filter`, `File path`, `Checker message` and `Report hash` filters +you can filter the results by using the `*` quantifiers which matches any +number of characters (zero or more). So if you have for example `run_1_a_name`, +`run_2_b_name`, `run_2_c_name`, `run_3_d_name` then `run_2*` will select +`run_2_b_name` and `run_2_c_name`. + +![Filter runs](images/reports/filter_runs.png) + +### Report count +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 REPORS** +button at the bottom 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/reports/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 +the top of the filter bar. + +![Clear all filters](images/reports/clear_all_filters.png) + +![Clear report filters](images/reports/clear_report_filters.png) + +### Unique reports +At the top of the filter panel there is a `Unique reports` checkbox. This +narrows the report list to unique bug (group findings that have the same +*Report Identifier* (report hash) within or across multiple runs). + +The same bug may appear several times if it is found on different control +paths, i.e. through different function calls or in multiple runs. By checking +`Unique reports` a report appears only once even if it is found on several +paths. + +![Unique reports](images/reports/unqiue_reports.png) + +Reports can be expanded to see all the reports with the same hash by using the +expand arrow (`v` icon) beside the report hash. + +**Note**: detection status is not shown in this view and only the file name is +shown because same report may have different detection statuses or can be +found under different file paths. + +## Compare mode +In compare mode you can calculate the difference between multiple analyses of +the project, showing which reports have been fixed and which are newly +introduced or which can be fined in all runs. + +At the **Baseline** filter section you can select the run names / tags against +which you want to check the difference. + +At the **Compare to** filter section you can select the run names / tags which +you want to compare against the *Baseline* runs and run tags. + +You can also use the `Outstanding report on a given date` filter to compare +reports by dates. + +### Compare two different runs +![Compare two different runs](images/reports/compare_runs.png) + +### Compare two different tagged versions of the same +![Compare two different tagged versions of the same](images/reports/compare_tags.png) + +## Manage source components +Source components are named collections of directory filters which can be used +to filter run results (reports) by multiple file paths. 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) +![Manage source components](images/reports/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) +![List of source components](images/reports/list_of_source_components.png) -# Bug view -At this page you can navigate between reports and check the errors what -CodeChecker found. +Each line should begin with a `+` or a `-`, followed by a path glob pattern: +- `+`: *ONLY* results from the matching file paths will be listed. +- `-`: results from the matching file paths will not be listed. -This page has four main parts: -- [Report navigation tree](#userguide-report-navigation-tree) -- [Button pane](#userguide-button-pane) -- [Bug path view](#userguide-bug-path-view) -- [Comments](#userguide-comment) +For more information [see](https://github.com/Ericsson/codechecker/blob/master/docs/web/user_guide.md#format-of-component-file). -![Report view](images/report_view.png) +# Report details +## Report Navigation Tree +Report Navigation Tree shows the found reports at the currently opened file. +The reports are grouped by the severity level. You can navigate between them +by clicking on a node in the tree. -## Report navigation tree -Report Navigation Tree shows the found reports at the currently opened file. The -reports are grouped by the severity level. -You can navigate between them by clicking on a node in the tree. +![Report navigation tree](images/report/report_navigation_tree.png) -![Report navigation tree](images/report_navigation_tree.png) - -## Button pane +## Button pane Button Pane contains several items which help you to change or get some -property of the currently opened report. -![Button pane](images/button_pane.png) +property of the currently opened report. + +![Button pane](images/report/button_pane.png) + +### Report info +`REPORT INFO` button shows detailed information about the currently opened +report such as *Report ID*, *Run name*, *Detection / Fix date* etc. + +### Show documentation +`SHOW DOCUMENTATION` button shows the documentation of the actual checker which +identified the currently opened report. -### Show documentation -Show Documentation button shows the documentation of the actual checker which -identified by the currently opened report. -![Checker documentation](images/checker_documentation.png) +![Checker documentation](images/report/checker_documentation.png) -### Change review status +### Change review status Reports can be assigned a review status of *Unreviewed*, *Confirmed*, *False -positive*, *Intentional*, along with an optional comment on why this status was -applied. We can change the review status from the default - _Unreviewed_ option +positive*, *Intentional* along with an optional comment on why this status was +applied. + +It can be changed on the GUI or by using +[source code comments](https://github.com/Ericsson/codechecker/blob/master/docs/analyzer/user_guide.md#source-code-comments) +(*codechecker_false_positive*, *codechecker_confirmed*, etc.) + +We can change the review status on the GUI from the default + *Unreviewed* option to something else in the report details view above the file view. -![Unreviewed](images/review_status_unreviewed.png) +![Unreviewed](images/report/review_status_unreviewed.png) If you changed the review status, you can optionally explain the reason why you changed it. -![Change review status](images/review_status_change.png) +![Change review status](images/report/review_status_change.png) If somebody has already changed the review status from the default one, you can see extra information (who changed the review status, when and why) beside -the review status selector by hovering on the message icon. This message icon is -hidden by default if nobody has changed the review status. -![Review status message](images/review_status_message.png) +the review status selector by hovering on the message icon. This message icon +is hidden by default if nobody has changed the review status. + +![Review status message](images/report/review_status_message.png) -## Same reports -Several reports may belong to a specific bug if the but itself can be reached on -different control paths. In the Bug viewer you can check whether the selected -bug is available on a different path. +**Note**: source code comments have priority over the value stored in the +database. + +## Same reports +Several reports may belong to a specific bug if the bug itself can be reached +on different control paths. With the `Found in` select option you can check +whether the selected report is available on a different path. -![Same reports](images/same_reports.png) +![Same reports](images/report/same_reports.png) -## Bug path view +## Bug path view Some checkers are able to follow the execution path along the control flow of -the program. If a bug appears on any of these paths, then CodeChecker is able to -present the full path on which this so called symbolic execution reached the +the program. If a bug appears on any of these paths, then CodeChecker is able +to present the full path on which this so called symbolic execution reached the place of error. This path can be checked in this bug path view. -![Bug path](images/bug_path.png) +![Bug path](images/report/bug_path.png) -## Comment -Bug reports can be commented. You can add new comments, -edit () and -delete () them. +## Comment +There are 2 types of comments: +- `user based` comments. +- `system` comments. + +You can add new user comments, edit +() and delete +() them. The author of the comment will be the currently logged in user. If the user is -not logged in, the author of the comment will be _Anonymous_. +not logged in, the author of the comment will be *Anonymous*. -Comments are shown for the same report found in multiple runs. +System comments are automatically generated on the following events: +- on user comment update. +- on review status change. -![Comment](images/comment.png) +System comments are cannot be removed. -# Run history -When selecting a run then a "Run history" tab appears next to the -*Bug overview*. In this window you can check the specific run events which -happened during a storage process under the same run name. This way you can list -the reports' state in the selected run event. +![Comment](images/report/comment.png) -![Run history](images/run_history.png) +**Note**: comments are connected to report hashes. This way the comments are +shown for the same report found in multiple runs. -# Server Configuration -## Global Notification banner -There is an option to set a global notification text, that will show on top of -every page over the CodeChecker logo. For every connecting client. +# Statistics -![Notification](images/notification.png) +## Statistics pages +Multiple statistics are available inside the GUI: +- [Product overview](#product-overview): overview of the quality status of the +current product. +- [Checker statistics](#checker-statistics): shows the number of reports +grouped by checker names. +- [Severity statistics](#severity-statistics): shows the number of reports +grouped by severity levels. +- [Component statistics](#component-statistics): shows the number of reports +grouped by source components. -You can edit this alert on the products page with "Edit announcement" button, -but **Super User** permissions are necessary. +### Product overview +This page shows an overview of the quality status of the current product. -![Products](images/products.png) +![Product overview](images/statistics/product_overview.png) -You can remove the current notification by saving an empty text. +It has the following sections: +- Number of *NEW* reports which were detected `today` / `yesterday` / +`last 7 days` / `last 31 days`. +- Number of *RESOLVED* reports which were detected `today` / `yesterday` / +`last 7 days` / `last 31 days`. +- Number of outstanding reports which are not fixed yet. +- Number of failed files in the current product. If you click to the number it +will show you the list of failed files in a dialog. +- Number of checkers reporting faults. +- Number of outstanding reports chart per severity level. By default it will +show statistics for the last 6 months. You can change it by using the input box +in the top-right corner of this chart. +- Component statistics table grouped by severity levels. Each row can be +expanded which will show a checker statistics for the actual component. + +### Checker statistics +Shows the number of reports grouped by checker names. + +![Checker statistics](images/statistics/checker_statistics.png) + +### Severity statistics +Shows the number of reports grouped by severity levels. + +![Severity statistics](images/statistics/severity_statistics.png) + +### Component statistics +Shows the number of reports grouped by source components. + +![Component statististics](images/statistics/component_statistics.png) + +Each row can be expanded by using the `^` button beside the component name. It +will show a checker statistics table for the selected component. + +![Component statististics](images/statistics/component_statistics_expanded.png) + +## Filtering statistics +We can get statistics only for specified runs, files, checker names etc. by +using the filter bar. + +For more information [see](#filtering-reports) + +### Uniqueing checker statistics +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. -![Notification Dialog](images/notificaiton_dialog.png) +You can find more information how the report hashes are generated +[here](https://github.com/Ericsson/codechecker/blob/master/docs/analyzer/report_identification.md). diff --git a/web/server/vue-cli/src/views/NewFeatures.vue b/web/server/vue-cli/src/views/NewFeatures.vue index 20b1f787d0..06f16a277f 100644 --- a/web/server/vue-cli/src/views/NewFeatures.vue +++ b/web/server/vue-cli/src/views/NewFeatures.vue @@ -917,7 +917,7 @@ Bug path length filter @@ -952,7 +952,7 @@ Macro expansion @@ -1040,7 +1040,7 @@ Report hash filter @@ -1062,7 +1062,7 @@ Checker statistics @@ -1084,7 +1084,7 @@ Remove filtered reports @@ -1108,7 +1108,7 @@ Manage source components @@ -1130,7 +1130,7 @@ Analysis statistics @@ -1142,32 +1142,21 @@ - - -

- Compiler warnings are diagnostic messages that report - constructions that are not inherently erroneous but that are - risky or suggest there may have been an error. You can - fine-tune which warnings to use in the analysis by setting - the enabled and disabled flags. These flags should start with - a capital W or Wno- prefix followed by the - warning name. -

- Examples: -
    -
  • - CodeChecker analyze /path/to/build.log -o /path/to/output/dir --enable Wunused --disable Wno-unused-parameter -
    • -
- - - Analysis statistics - - +

+ Compiler warnings are diagnostic messages that report + constructions that are not inherently erroneous but that are + risky or suggest there may have been an error. You can + fine-tune which warnings to use in the analysis by setting + the enabled and disabled flags. These flags should start with + a capital W or Wno- prefix followed by the + warning name. +

+ Examples: + @@ -1242,7 +1231,7 @@ Component filter @@ -1263,7 +1252,7 @@ Diff tagged versions of the same run @@ -1294,7 +1283,7 @@ Plist to html