Skip to content

Commit 1c3c9c3

Browse files
committed
INSTALL.md: document expected output
1 parent e95c3d4 commit 1c3c9c3

1 file changed

Lines changed: 40 additions & 1 deletion

File tree

INSTALL.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,43 @@ Once the image has been build, you can start the demo with
4343
./docker.sh demo
4444
```
4545

46-
## Nix Setup
46+
## Nix Setup
47+
48+
## Expected Output
49+
50+
The expected output is close to the output shown at the end of the [screencast](https://www.youtube.com/watch?v=q6ight5EDQY).
51+
When you run the demo, a text-based diff should be printed to the terminal, followed by four windows opening up:
52+
![Screenshot of expected output](docs/expected_output_1.png).
53+
After closing these windows (use `ESC` key for fast closing), there should be another four windows opening with the same trees and diffs but not in the simplified "foo/bar" version.
54+
After closing these windows, a small example analysis of the xterm repository should run in the terminal.
55+
The analysis should take about 30s-5min, and its output to terminal should look similar to this:
56+
```
57+
2024-04-27 11:40:46 INFO [AnalysisRunner.run] Reading and cloning git repositories from/to: data\repos
58+
2024-04-27 11:40:46 INFO [AnalysisRunner.run] Writing output to: data\output
59+
2024-04-27 11:40:46 INFO [AnalysisRunner.run] Loading datasets file: data\demo-dataset.md
60+
2024-04-27 11:40:46 INFO [AnalysisRunner.run] Performing validation on the following repositories:
61+
2024-04-27 11:40:46 INFO [AnalysisRunner.run] - xterm from https://github.com/DiffDetective/xterm.git
62+
2024-04-27 11:40:46 INFO [AnalysisRunner.run] Preloading repositories:
63+
2024-04-27 11:40:46 INFO [Repository.load] Loading git at data\repos\xterm ...
64+
2024-04-27 11:40:47 INFO [Analysis.forEachRepository] === Begin Processing xterm ===
65+
2024-04-27 11:40:47 INFO [Analysis.forEachCommit] >>> Scheduling asynchronous analysis on 8 threads.
66+
2024-04-27 11:40:47 INFO [Analysis.forEachCommit] <<< done in 0.222s
67+
2024-04-27 11:40:47 INFO [Analysis.forEachCommit] >>> Run Analysis
68+
2024-04-27 11:41:21 INFO [DemoAnalysis.endBatch] Batch done: 11 commits analyzed
69+
2024-04-27 11:41:38 INFO [DemoAnalysis.endBatch] Batch done: 20 commits analyzed
70+
2024-04-27 11:41:39 INFO [DemoAnalysis.endBatch] Batch done: 20 commits analyzed
71+
2024-04-27 11:41:39 INFO [DemoAnalysis.endBatch] Batch done: 20 commits analyzed
72+
2024-04-27 11:41:40 INFO [DemoAnalysis.endBatch] Batch done: 20 commits analyzed
73+
2024-04-27 11:41:40 INFO [DemoAnalysis.endBatch] Batch done: 20 commits analyzed
74+
2024-04-27 11:41:40 INFO [Analysis.forEachCommit] <<< done in 53.09s
75+
2024-04-27 11:41:40 INFO [Analysis.exportMetadataToFile] Metadata:
76+
analysis: my analysis
77+
repository: xterm
78+
big diffs: 188
79+
runtime with multithreading in seconds: 53.09
80+
total commits: 111
81+
82+
2024-04-27 11:41:40 INFO [Analysis.forEachRepository] === End Processing xterm after 53.379s ===
83+
2024-04-27 11:41:40 INFO [AnalysisRunner.run] Done
84+
```
85+
The output files of the analysis should be located at [data/output](data/output).

0 commit comments

Comments
 (0)