Skip to content

Commit

Permalink
Updated images with arrows
Browse files Browse the repository at this point in the history
  • Loading branch information
@Szelethus
Szelethus authored Sep 20, 2023
1 parent a7bf1d0 commit b1e2b26
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions docs/web/diff.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ remote-remote, and local-remote or remote-local diffs.

You can also compare runs on the web GUI. On the "Run" page, on the right side of each report, you can see square shaped radio buttons. Clicking on the first one places the run into the "baseline" set, and clicking on the second places it in the "newline" set. After selecting at least one run into each set, you can press the "Diff" button in the upper right corner of the "Run" page.

![image](https://github.com/Szelethus/codechecker/assets/23276031/75490051-86df-419d-998a-ec89942faca1)
![image](https://github.com/Szelethus/codechecker/assets/23276031/d93d7a73-5071-49df-a00e-5cf932c10c16)

Read more [here](../../web/server/vue-cli/src/assets/userguide/userguide.md#compare-runs).

Expand Down Expand Up @@ -502,11 +502,11 @@ The image below shows the set of outstanding reports in both of these runs. In t

Select "Test Run" to be in the "baseline" set by clicking on the left radio button on the right hand side. Select "Test Run Updated" to be in the "newline" set by clicking on the other one. Click on "DIFF" in the upper right corner.

![image](https://github.com/Szelethus/codechecker/assets/23276031/75490051-86df-419d-998a-ec89942faca1)
![image](https://github.com/Szelethus/codechecker/assets/23276031/c7a3d57d-79f5-4610-ab74-b9ec9b5a2f76)

In the middle of the image, we can see the list of oustadning reports that appeared from the baseline to the newline. In the bottom left corner, by clicking on the cogwheel next to "Diff type", you can change diff type:

![image](https://github.com/Szelethus/codechecker/assets/23276031/d279551a-a750-4d18-9f78-459c40bfb726)
![image](https://github.com/Szelethus/codechecker/assets/23276031/f731b4a2-d49c-4af8-a42f-1b394a3eb8a2)

The list of reports that are no longer outstadning from the baseline to the newline:

Expand Down Expand Up @@ -647,15 +647,15 @@ CodeChecker store -n "Test Run" ./test_report_dir

Now, navigate to the the web GUI, and create review status rules. Click on "Test Run".

![image](https://github.com/Szelethus/codechecker/assets/23276031/c308038d-466f-453c-ad41-e69cb789ff4d)
![image](https://github.com/Szelethus/codechecker/assets/23276031/73adda30-7e03-4117-bc1a-ecac9c01a2b1)

Click on the first report, emitted by `deadcode.DeadStores`.

![image](https://github.com/Szelethus/codechecker/assets/23276031/1e6c47d6-d9f6-44c9-a770-08108ed53a04)
![image](https://github.com/Szelethus/codechecker/assets/23276031/519551df-f182-4350-8acf-d79edf8c00a2)

Set its review status to false positive.

![image](https://github.com/Szelethus/codechecker/assets/23276031/3c431590-8c62-43cc-b22d-20090d0ae844)
![image](https://github.com/Szelethus/codechecker/assets/23276031/2bde9a6c-2f7b-4a50-a101-06e6766f8ef2)

Now, modify `example.cpp`: fix the `core.DivideZero` error and introduce a null dereference error:

Expand Down Expand Up @@ -693,11 +693,11 @@ CodeChecker store -n "Test Run Updated" ./test_report_dir_updated

Looking at the web GUI, you can observe that the report emitted by `deadcode.DeadStores` has a false positive review status, shown by the grey no entry sign :no_entry_sign: in the Review Status column. Note that we cleared the review status filter, which won't list false positive reports by default. Below is the "Reports" view for "Test Run":

![image](https://github.com/Szelethus/codechecker/assets/23276031/eca40d1c-42a7-49c9-800b-ba26f647fae2)
![image](https://github.com/Szelethus/codechecker/assets/23276031/3117b9fd-bda0-495f-94a3-1d8843f1c8f5)

Below is the "Reports" view for "Test Run Updated":

![image](https://github.com/Szelethus/codechecker/assets/23276031/be1aa0fa-210d-4b5e-8598-0cf98c9ca484)
![image](https://github.com/Szelethus/codechecker/assets/23276031/97c1bb34-0b2e-4244-ae3c-9cdb7a2ffc9d)

As a result, this report is not outstanding in either of the runs:

Expand Down Expand Up @@ -799,16 +799,15 @@ CodeChecker store -n "Test Run" ./test_report_dir --tag tag1

Now, navigate to the the web GUI, and create review status rules. Click on "Test Run".

![image](https://github.com/Szelethus/codechecker/assets/23276031/c308038d-466f-453c-ad41-e69cb789ff4d)
![image](https://github.com/Szelethus/codechecker/assets/23276031/73adda30-7e03-4117-bc1a-ecac9c01a2b1)

Click on the first report, emitted by `deadcode.DeadStores`.


![image](https://github.com/Szelethus/codechecker/assets/23276031/1e6c47d6-d9f6-44c9-a770-08108ed53a04)
![image](https://github.com/Szelethus/codechecker/assets/23276031/519551df-f182-4350-8acf-d79edf8c00a2)

Set its review status to false positive.

![image](https://github.com/Szelethus/codechecker/assets/23276031/72dc2cf1-ca7c-44e1-afbe-f1f98adf6e62)
![image](https://github.com/Szelethus/codechecker/assets/23276031/2bde9a6c-2f7b-4a50-a101-06e6766f8ef2)

Now, modify `example.cpp`: fix the `core.DivideZero` error and introduce a null dereference error:

Expand Down Expand Up @@ -900,4 +899,4 @@ Given the chronological order that we first analyzer and stored `tag1`, _and the

After clicking the dropdown button next to "Test Run", select tags to be put in the baseline and newline sets. Then, click the "DIFF" button the upper left corner. You can interpret the results the same way as in the [first example](#using-the-web-gui).

![image](https://github.com/Szelethus/codechecker/assets/23276031/4e1b8c94-ba1e-449c-b719-3187d5bec06c)
![image](https://github.com/Szelethus/codechecker/assets/23276031/7c464eca-5b19-491c-889f-c489eebfffd5)

0 comments on commit b1e2b26

Please sign in to comment.