Skip to content

Commit c84d0ea

Browse files
dkruppdkrupp
authored
Merge pull request #4725 from gulyasgergely902/new-features-6-27
[feature] Add new 6.27.0 version highlights to CodeChecker
2 parents d27a55c + 4c19f6e commit c84d0ea

File tree

4 files changed

+143
-1
lines changed

4 files changed

+143
-1
lines changed

‎web/server/vue-cli/src/assets/userguide/images/new_features/6.27.0/navigable-numbers.png‎

21.8 KB
Loading

‎web/server/vue-cli/src/assets/userguide/images/new_features/6.27.0/non-compliant.png‎

87.1 KB
Loading

‎web/server/vue-cli/src/assets/userguide/images/new_features/6.27.0/single-origin.png‎

68.8 KB
Loading

‎web/server/vue-cli/src/views/NewFeatures.vue‎

Lines changed: 143 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,149 @@
22
<!-- eslint-disable max-len -->
33
<v-container fluid>
44
<v-timeline align-top>
5+
<v-timeline-item fill-dot icon="mdi-star" color="green lighten-1">
6+
<new-release-item color="green lighten-1">
7+
<template v-slot:title>
8+
<a
9+
href="https://github.com/Ericsson/codechecker/releases/tag/v6.27.0"
10+
target="_blank"
11+
class="white--text"
12+
>
13+
Highlights of CodeChecker 6.27.0 release
14+
</a>
15+
</template>
16+
17+
<new-feature-item>
18+
<template v-slot:title>
19+
Asynchronous Store
20+
</template>
21+
<p>
22+
CodeChecker changes it's store execution model from synchronous
23+
to asynchronous mode.
24+
</p>
25+
<p>
26+
The <code>CodeChecker store</code> command will not have to wait
27+
synchronously for the server to finish the storage procedure of the
28+
reports, but can seamlessly continue execution after the store
29+
process started. Then later, it can query the status of the storage
30+
task from the server.
31+
</p>
32+
<p>
33+
This provides more stable report storage procedures as many
34+
users expereinced broken TCP connections during large analysis
35+
results storage batches.
36+
</p>
37+
<p>
38+
CodeChecker will provide a command line utility for admins to
39+
query ongoing/finished/cancelled storage processes with
40+
filtering option.
41+
</p>
42+
<pre style="overflow-x: scroll;">
43+
❯ build/CodeChecker/bin/CodeChecker cmd serverside-tasks --enqueued-after 2024:08:19 --status cancelled
44+
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
45+
Token | Machine | Type | Summary | Status | Product | User | Enqueued | Started | Last seen | Completed | Cancelled?
46+
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
47+
8b62497c7d1b7e3945445f5b9c3951d97ae07e58f97cad60a0187221e7d1e2ba | xxxxxxxxxxxxx:8001 | taskService::DummyTask | Dummy task for testing purposes | CANCELLED | | | 2024-08-19 15:55:34 | 2024-08-19 15:55:34 | 2024-08-19 15:55:35 | 2024-08-19 15:55:35 | Yes
48+
6fa0097a9bd1799572c7ccd2afc0272684ed036c11145da7eaf40cc8a07c7241 | xxxxxxxxxxxxx:8001 | taskService::DummyTask | Dummy task for testing purposes | CANCELLED | | | 2024-08-19 15:55:53 | 2024-08-19 15:55:53 | 2024-08-19 15:55:53 | 2024-08-19 15:55:53 | Yes
49+
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
50+
</pre>
51+
</new-feature-item>
52+
53+
<new-feature-item>
54+
<template v-slot:title>
55+
Detailed analysis status command
56+
</template>
57+
<pre>
58+
CodeChecker parse --status ./report_dir [--detailed] [-e json]
59+
</pre>
60+
<p>
61+
This command provides a clear overview of the current state of
62+
analysis results within the report directory, indicating which
63+
reports are up to date, which are outdated, which analyses have
64+
failed, and which files were never processed (e.g. skipped).
65+
</p>
66+
<p>
67+
Example output:
68+
</p>
69+
<pre>
70+
----==== Summary ====----
71+
Up-to-date analysis results
72+
clangsa: 311
73+
clang-tidy: 311
74+
Outdated analysis results
75+
Failed to analyze
76+
clangsa: 20
77+
clang-tidy: 20
78+
Missing analysis results
79+
clangsa: 18
80+
clang-tidy: 18
81+
cppcheck: 349
82+
Total analyzed compilation commands: 331
83+
Total available compilation commands: 349
84+
----=================----
85+
</pre>
86+
<p>
87+
The <code>--detailed</code> flag shows the exact files involved
88+
instead of just counts. For automated workflows, the
89+
<code>-e json</code> option provides the status info in a format
90+
that can be easily processed.
91+
</p>
92+
</new-feature-item>
93+
94+
<new-feature-item>
95+
<template v-slot:title>
96+
New Component Filter mode: single-origin-report
97+
</template>
98+
<p>
99+
A new report filter option is introduced to CodeChecker:
100+
Single Origin mode. This option makes it possible to filter only
101+
those reports which are contained entirely within a source code
102+
component. To use it, select the "Single Origin" mode when
103+
editing the Source Component filter in the Reports view.
104+
</p>
105+
<p>
106+
This new option is also available from the command line using
107+
the <code>--single-origin-report</code> argument.
108+
E.g: <code>CodeChecker cmd results --single-origin-report --component my_component ...</code>
109+
</p>
110+
<img
111+
src="@/assets/userguide/images/new_features/6.27.0/single-origin.png"
112+
alt="Single Origin Report Filter"
113+
width="100%"
114+
>
115+
</new-feature-item>
116+
117+
<new-feature-item>
118+
<template v-slot:title>
119+
Highlight non-compliant guideline rules
120+
</template>
121+
<p>
122+
Non-compliant rules are highlighed in the SEI-Cert statistics
123+
and compliant rules can be hidden.
124+
</p>
125+
<img
126+
src="@/assets/userguide/images/new_features/6.27.0/non-compliant.png"
127+
alt="Non-compliant Rule Highlight"
128+
width="100%"
129+
>
130+
</new-feature-item>
131+
132+
<new-feature-item>
133+
<template v-slot:title>
134+
Navigable numbers in the product statistics page
135+
</template>
136+
<p>
137+
The values of the outstanding reports graph are now clickable.
138+
</p>
139+
<img
140+
src="@/assets/userguide/images/new_features/6.27.0/navigable-numbers.png"
141+
alt="Navigable Statistics Numbers"
142+
width="100%"
143+
>
144+
</new-feature-item>
145+
</new-release-item>
146+
</v-timeline-item>
147+
5148
<v-timeline-item fill-dot icon="mdi-star">
6149
<new-release-item>
7150
<template v-slot:title>
@@ -91,7 +234,6 @@
91234
</new-release-item>
92235
</v-timeline-item>
93236

94-
95237
<v-timeline-item fill-dot icon="mdi-star" color="green lighten-1">
96238
<new-release-item color="green lighten-1">
97239
<template v-slot:title>

0 commit comments

Comments
 (0)