Skip to content

Commit 6c8cab6

Browse files
committed
add in docs that a build log file is generated
Signed-off-by: habibayassin <[email protected]>
1 parent a4f921e commit 6c8cab6

File tree

4 files changed

+9
-3
lines changed

4 files changed

+9
-3
lines changed

.github/ISSUE_TEMPLATE/bug_report_with_orfs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,9 @@ body:
100100
id: logs
101101
attributes:
102102
label: Relevant log output
103-
description: Feel free to add any relevant log snippets to this section. This will be automatically formatted into code, so no need for backticks.
103+
description: |
104+
You can upload `build_openroad.log` file found in the main directory by dragging and dropping it below.
105+
Feel free to add any other relevant log snippets to this section. This will be automatically formatted into code, so no need for backticks.
104106
render: shell
105107
validations:
106108
required: false

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](getting:started:setup:build).
66

77
## Logger
88

docs/user/BuildLocally.md

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

30+
```{note}
31+
There is a `build_openroad.log` file that is generated with every build in the main directory. In case of filing issues, it can be uploaded in the "Relevant log output" section of OpenROAD-flow-scripts repo [issue form](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/issues/new?assignees=&labels=&template=bug_report_with_orfs.yml).
32+
```
33+
3034
## Verify Installation
3135

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

docs/user/GettingStarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ To build the binaries and run `gcd` through the flow:
2121
Larger designs may require better hardware.
2222

2323
---
24-
24+
(getting:started:setup:build)=
2525
### Building and Installing the Software
2626

2727
**WARNING**

0 commit comments

Comments
 (0)