Skip to content

Commit 420fc04

Browse files
habibayassinhabibayassin
committed
create a generic build page
Signed-off-by: habibayassin <[email protected]>
1 parent 65edfdb commit 420fc04

File tree

6 files changed

+60
-71
lines changed

6 files changed

+60
-71
lines changed

‎docs/contrib/DeveloperGuide.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Building
44

5-
Instructions for building are available [here](../user/GettingStarted.md).
5+
Instructions for building are available [here](./Build.md).
66

77
## Logger
88

‎docs/toc.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ entries:
1717
- file: user/GettingStarted
1818
title: Getting Started with OpenROAD Flow
1919
entries:
20+
- file: user/Build
21+
title: Build OpenROAD Flow
2022
- file: user/BuildWithDocker
2123
title: Build With Docker
2224
- file: user/BuildLocally

‎docs/user/Build.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Build OpenROAD Flow
2+
3+
:::{warning}
4+
On CentOS 7 you need to manually make sure the PATH variable includes at
5+
least one of the new version of GCC/Clang. To enable GCC-8 or Clang-7 you
6+
need to run:
7+
8+
```shell
9+
# to enable gcc-8
10+
source /opt/rh/devtoolset-8/enable
11+
# or to enable clang-7
12+
source /opt/rh/llvm-toolset-7.0/enable
13+
```
14+
:::
15+
16+
## Build Command and options
17+
18+
``` shell
19+
./build_openroad.sh
20+
```
21+
22+
Options for `./build_openroad.sh` script
23+
| Argument | Description |
24+
|-------------------------------|---------------------------------------------------------------------------------------|
25+
| `-h` or `--help` | Print help message. |
26+
| `-o` or `--local` | Build locally instead of building a Docker image. |
27+
| `-l` or `--latest` | Use the head of branch --or_branch or 'master' by default for tools/OpenROAD. |
28+
| `--or_branch BRANCH_NAME` | Use the head of branch BRANCH for tools/OpenROAD. |
29+
| `--or_repo REPO_URL` | Use a fork at REPO-URL (https/ssh) for tools/OpenROAD. |
30+
| `--no_init` | Skip initializing submodules. |
31+
| `-t N` or `--threads N` | Use N cpus when compiling software. |
32+
| `-n` or `--nice` | Nice all jobs. Use all cpus unless `--threads` is also given, then use N threads. |
33+
| `--yosys-args-overwrite` | Do not use default flags set by this scrip during Yosys compilation. |
34+
| `--yosys-args STRING` | Aditional compilation flags for Yosys compilation. |
35+
| `--openroad-args-overwrite` | Do not use default flags set by this script during OpenROAD app compilation. |
36+
| `--openroad-args STRING` | Aditional compilation flags for OpenROAD app compilation. |
37+
| `--lsoracle-enable` | Compile LSOracle. Disable by default as it is not currently used on the flow. |
38+
| `--lsoracle-args-overwrite` | Do not use default flags set by this scrip during LSOracle compilation. |
39+
| `--lsoracle-args STRING` | Aditional compilation flags for LSOracle compilation. |
40+
| `--install-path PATH` | Path to install tools. Default is `${INSTALL_PATH}`. |
41+
| `--clean` | Call git clean interactively before compile. Useful to remove old build files. |
42+
| `--clean-force` | Call git clean before compile. WARNING: this option will not ask for confirmation. Useful to remove old build files. |
43+
| `-c` or `--copy-platforms` | Only applicable for docker builds. Copy platforms to inside docker image. |
44+
| `--docker-args-overwrite` | Only applicable for docker builds. Do not use default flags set by this script for Docker builds. |
45+
| `--docker-args STRING` | Only applicable for docker builds. Additional compilation flags for Docker build. |
46+
47+
48+
## Build from sources locally
49+
50+
Build from sources locally, [instructions here](./BuildLocally.md).
51+
52+
## Build from sources using Docker
53+
54+
Build from sources using Docker, [instructions here](./BuildWithDocker.md).

‎docs/user/BuildLocally.md‎

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -27,28 +27,6 @@ cd OpenROAD-flow-scripts
2727
./build_openroad.sh --local
2828
```
2929

30-
Options for `./build_openroad.sh` script
31-
| Argument | Description |
32-
|-------------------------------|---------------------------------------------------------------------------------------|
33-
| `-h` or `--help` | Print help message. |
34-
| `-o` or `--local` | Build locally instead of building a Docker image. |
35-
| `-l` or `--latest` | Use the head of branch --or_branch or 'master' by default for tools/OpenROAD. |
36-
| `--or_branch BRANCH_NAME` | Use the head of branch BRANCH for tools/OpenROAD. |
37-
| `--or_repo REPO_URL` | Use a fork at REPO-URL (https/ssh) for tools/OpenROAD. |
38-
| `--no_init` | Skip initializing submodules. |
39-
| `-t N` or `--threads N` | Use N cpus when compiling software. |
40-
| `-n` or `--nice` | Nice all jobs. Use all cpus unless `--threads` is also given, then use N threads. |
41-
| `--yosys-args-overwrite` | Do not use default flags set by this scrip during Yosys compilation. |
42-
| `--yosys-args STRING` | Aditional compilation flags for Yosys compilation. |
43-
| `--openroad-args-overwrite` | Do not use default flags set by this script during OpenROAD app compilation. |
44-
| `--openroad-args STRING` | Aditional compilation flags for OpenROAD app compilation. |
45-
| `--lsoracle-enable` | Compile LSOracle. Disable by default as it is not currently used on the flow. |
46-
| `--lsoracle-args-overwrite` | Do not use default flags set by this scrip during LSOracle compilation. |
47-
| `--lsoracle-args STRING` | Aditional compilation flags for LSOracle compilation. |
48-
| `--install-path PATH` | Path to install tools. Default is `${INSTALL_PATH}`. |
49-
| `--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. Useful to remove old build files. |
51-
5230
## Verify Installation
5331

5432
The binaries should be available on your `$PATH` after setting up the

‎docs/user/BuildWithDocker.md‎

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ For this method you only need to install
77

88
---
99

10-
**WARNING**
11-
10+
:::{warning}
1211
The `build_openroad.sh` will use the host number of CPUs to compile `openroad`.
1312

1413
Please check your Docker daemon setup to make sure all host CPUs are
@@ -28,8 +27,7 @@ You can restrict the number of CPUs with the `-t|--threads N` argument:
2827
``` shell
2928
./build_openroad.sh --threads N
3029
```
31-
32-
---
30+
:::
3331

3432
## Clone and Build
3533

@@ -38,31 +36,6 @@ git clone --recursive https://github.com/The-OpenROAD-Project/OpenROAD-flow-scri
3836
cd OpenROAD-flow-scripts
3937
./build_openroad.sh
4038
```
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-
6639

6740
## Verify Installation
6841

‎docs/user/GettingStarted.md‎

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,25 +24,7 @@ Larger designs may require better hardware.
2424

2525
### Building and Installing the Software
2626

27-
**WARNING**
28-
29-
On CentOS 7 you need to manually make sure the PATH variable includes at
30-
least one of the new version of GCC/Clang. To enable GCC-8 or Clang-7 you
31-
need to run:
32-
33-
```shell
34-
# to enable gcc-8
35-
source /opt/rh/devtoolset-8/enable
36-
# or to enable clang-7
37-
source /opt/rh/llvm-toolset-7.0/enable
38-
```
39-
40-
---
41-
42-
There are currently two options to set up the OpenROAD Flow:
43-
44-
- Build from sources using Docker, [instructions here](./BuildWithDocker.md).
45-
- Build from sources locally, [instructions here](./BuildLocally.md).
27+
Instructions for building are available [here](./Build.md).
4628

4729

4830
## Running a Design

0 commit comments

Comments
 (0)