Skip to content

Commit 65edfdb

Browse files
committed
add table for args in build with docker
Signed-off-by: habibayassin <[email protected]>
1 parent 878075d commit 65edfdb

File tree

3 files changed

+29
-5
lines changed

3 files changed

+29
-5
lines changed

build_openroad.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Options:
9494
currently used on the flow.
9595
9696
--lsoracle-args-overwrite
97-
Do not use default flags set by this scrip during
97+
Do not use default flags set by this script during
9898
LSOracle compilation.
9999
100100
--lsoracle-args STRING Aditional compilation flags for LSOracle

docs/user/BuildLocally.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ cd OpenROAD-flow-scripts
2828
```
2929

3030
Options for `./build_openroad.sh` script
31-
| Argument | Value |
31+
| Argument | Description |
3232
|-------------------------------|---------------------------------------------------------------------------------------|
3333
| `-h` or `--help` | Print help message. |
3434
| `-o` or `--local` | Build locally instead of building a Docker image. |
@@ -40,15 +40,14 @@ Options for `./build_openroad.sh` script
4040
| `-n` or `--nice` | Nice all jobs. Use all cpus unless `--threads` is also given, then use N threads. |
4141
| `--yosys-args-overwrite` | Do not use default flags set by this scrip during Yosys compilation. |
4242
| `--yosys-args STRING` | Aditional compilation flags for Yosys compilation. |
43-
| `--openroad-args-overwrite` | Do not use default flags set by this scrip during OpenROAD app compilation. |
43+
| `--openroad-args-overwrite` | Do not use default flags set by this script during OpenROAD app compilation. |
4444
| `--openroad-args STRING` | Aditional compilation flags for OpenROAD app compilation. |
4545
| `--lsoracle-enable` | Compile LSOracle. Disable by default as it is not currently used on the flow. |
4646
| `--lsoracle-args-overwrite` | Do not use default flags set by this scrip during LSOracle compilation. |
4747
| `--lsoracle-args STRING` | Aditional compilation flags for LSOracle compilation. |
4848
| `--install-path PATH` | Path to install tools. Default is `${INSTALL_PATH}`. |
4949
| `--clean` | Call git clean interactively before compile. Useful to remove old build files. |
50-
| `--clean-force` | Call git clean before compile. WARNING: this option will not ask for confirmation. |
51-
| | Useful to remove old build files. |
50+
| `--clean-force` | Call git clean before compile. WARNING: this option will not ask for confirmation. Useful to remove old build files. |
5251

5352
## Verify Installation
5453

docs/user/BuildWithDocker.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,31 @@ git clone --recursive https://github.com/The-OpenROAD-Project/OpenROAD-flow-scri
3838
cd OpenROAD-flow-scripts
3939
./build_openroad.sh
4040
```
41+
Options for `./build_openroad.sh` script
42+
| Argument | Description |
43+
|-------------------------------|---------------------------------------------------------------------------------------|
44+
| `-h` or `--help` | Print help message. |
45+
| `-o` or `--local` | Build locally instead of building a Docker image. |
46+
| `-l` or `--latest` | Use the head of branch --or_branch or 'master' by default for tools/OpenROAD. |
47+
| `--or_branch BRANCH_NAME` | Use the head of branch BRANCH for tools/OpenROAD. |
48+
| `--or_repo REPO_URL` | Use a fork at REPO-URL (https/ssh) for tools/OpenROAD. |
49+
| `--no_init` | Skip initializing submodules. |
50+
| `-t N` or `--threads N` | Use N cpus when compiling software. |
51+
| `-n` or `--nice` | Nice all jobs. Use all cpus unless `--threads` is also given, then use N threads. |
52+
| `--yosys-args-overwrite` | Do not use default flags set by this scrip during Yosys compilation. |
53+
| `--yosys-args STRING` | Aditional compilation flags for Yosys compilation. |
54+
| `--openroad-args-overwrite` | Do not use default flags set by this script during OpenROAD app compilation. |
55+
| `--openroad-args STRING` | Aditional compilation flags for OpenROAD app compilation. |
56+
| `--lsoracle-enable` | Compile LSOracle. Disable by default as it is not currently used on the flow. |
57+
| `--lsoracle-args-overwrite` | Do not use default flags set by this scrip during LSOracle compilation. |
58+
| `--lsoracle-args STRING` | Aditional compilation flags for LSOracle compilation. |
59+
| `--install-path PATH` | Path to install tools. Default is `${INSTALL_PATH}`. |
60+
| `--clean` | Call git clean interactively before compile. Useful to remove old build files. |
61+
| `--clean-force` | Call git clean before compile. WARNING: this option will not ask for confirmation. Useful to remove old build files. |
62+
| `-c` or `--copy-platforms` | Copy platforms to inside docker image. |
63+
| `--docker-args-overwrite` | Do not use default flags set by this script for Docker builds. |
64+
| `--docker-args STRING` | Aditional compilation flags for Docker build. |
65+
4166

4267
## Verify Installation
4368

0 commit comments

Comments
 (0)