You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.developers.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ In the event that you are responsible for "breaking the build", fix the build at
10
10
11
11
We have some guidelines in place to help catch most of these problems:
12
12
13
-
1. Before you push code to the central repository, your code MUST pass the check-in regression test.
13
+
1. Before you push code to the central repository, your code MUST pass the check-in regression test.
14
14
The check-in regression test is a quick way to test if any part of the VTR flow is broken.
15
15
16
16
At a minimum you must run:
@@ -37,9 +37,9 @@ We have some guidelines in place to help catch most of these problems:
37
37
See [Adding Tests](#adding-tests) for details.
38
38
39
39
4. In the event a regression test is broken, the one responsible forhaving the test pass isin charge of determining:
40
-
* If there is a bug in the source code, in which case the source code needs to be updated to fix the bug, or
41
-
* If there is a problem with the test (perhaps the quality of the tool did in fact get better or perhaps there is a bug with the test itself), in which case the test needs to be updated to reflect the new changes.
42
-
40
+
* If there is a bug in the source code, in which case the source code needs to be updated to fix the bug, or
41
+
* If there is a problem with the test (perhaps the quality of the tool did in fact get better or perhaps there is a bug with the test itself), in which case the test needs to be updated to reflect the new changes.
42
+
43
43
If the golden results need to be updated and you are sure that the new golden results are better, use the command `../scripts/parse_vtr_task.pl -create_golden your_regression_test_name_here`
44
44
45
45
5. Keep in sync with the master branch as regularly as you can (i.e. `git pull` or `git pull --rebase`).
@@ -88,9 +88,9 @@ There are 4 main regression tests:
88
88
* MCNC20 benchmarks
89
89
* VTR benchmarks
90
90
* Titan 'other' benchmarks (smaller than Titan23)
91
-
91
+
92
92
**Architectures:** A wider variety of architectures
93
-
93
+
94
94
* `vtr_reg_weekly`: ~30 hours with `-j2`
95
95
96
96
**Goal:** Full QoR and Performance evaluation.
@@ -101,7 +101,7 @@ There are 4 main regression tests:
101
101
102
102
* VTR benchmarks
103
103
* Titan23 benchmarks
104
-
104
+
105
105
**Architectures:** A wide variety of architectures
You can now edit `strong_mytest/config/config.txt` to customize your test.
258
-
258
+
259
259
2. Generate golden reference results
260
260
261
261
Now we need to test our new test and generate 'golden' reference results.
@@ -411,7 +411,7 @@ To submit a build to coverity do the following:
411
411
Note that we explicitly asked for gcc and g++, the coverity build tool defaults to these compilers, and may not like the default 'cc' or 'c++' (even if they are linked to gcc/g++).
412
412
413
413
3. Run the coverity build tool
414
-
414
+
415
415
```shell
416
416
#From the build directory where we ran cmake
417
417
cov-build --dir cov-int make -j8
@@ -437,7 +437,7 @@ You may need to configure coverity to 'know' about your compiler. For example:
437
437
```shell
438
438
cov-configure --compiler `which gcc-7`
439
439
```
440
-
440
+
441
441
On unix-like systems run `scan-build make` from the root VTR directory.
442
442
to output the html analysis to a specific folder, run `scan-build make -o /some/folder`
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Introduction
2
-
The Verilog-to-Routing (VTR) project is a world-wide collaborative effort to provide a open-source framework for conducting FPGA architecture and CAD research and development.
2
+
The Verilog-to-Routing (VTR) project is a world-wide collaborative effort to provide a open-source framework for conducting FPGA architecture and CAD research and development.
3
3
The VTR design flow takes as input a Verilog description of a digital circuit, and a description of the target FPGA architecture.
4
4
It then perfoms:
5
5
* Elaboration & Synthesis (ODIN II)
@@ -33,9 +33,9 @@ Bibtex:
33
33
author={Luu, Jason and Goeders, Jeff and Wainberg, Michael and Somerville, Andrew and Yu, Thien and Nasartschuk, Konstantin and Nasr, Miad and Wang, Sen and Liu, Tim and Ahmed, Norrudin and Kent, Kenneth B. and Anderson, Jason and Rose, Jonathan and Betz, Vaughn},
@@ -61,16 +61,16 @@ If you have questions, or want to keep up-to-date with VTR, consider joining our
61
61
[VTR-Commits](https://groups.google.com/forum/#!forum/vtr-commits): VTR revision control commits
62
62
63
63
# Development
64
-
This is the development trunk for the Verilog-to-Routing project.
65
-
Unlike the nicely packaged releases that we create, you are working with code in a constant state of flux.
64
+
This is the development trunk for the Verilog-to-Routing project.
65
+
Unlike the nicely packaged releases that we create, you are working with code in a constant state of flux.
66
66
You should expect that the tools are not always stable and that more work is needed to get the flow to run.
67
67
68
-
For new developers, please [do the tutorial](dev/tutorial/NewDeveloperTutorial.txt).
68
+
For new developers, please [do the tutorial](dev/tutorial/NewDeveloperTutorial.txt).
69
69
You will be directed back here once you ramp up.
70
70
71
-
VTR development follows a classic centralized repository (svn-like) workflow.
72
-
The 'master' branch is supposed to be the most current stable version of the project.
73
-
Developers checkout a local copy of the code at the start of development, then do regular updates (e.g. `git pull --rebase`) to keep in sync with the GitHub master.
71
+
VTR development follows a classic centralized repository (svn-like) workflow.
72
+
The 'master' branch is supposed to be the most current stable version of the project.
73
+
Developers checkout a local copy of the code at the start of development, then do regular updates (e.g. `git pull --rebase`) to keep in sync with the GitHub master.
74
74
When a developer has a tested, working change to put back into the trunk, he/she performs a `git push` operation.
75
75
Unstable code should remain in the developer's local copy.
0 commit comments