Skip to content

Commit 10d9426

Browse files
authored
Merge pull request #770 from habibayassin/edit-docs
add in docs that the build log file is generated
2 parents fe22850 + e99bf99 commit 10d9426

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
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](./Build.md).
5+
Instructions for building are available [here](../user/Build.md).
66

77
## Logger
88

docs/user/BuildLocally.md

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

30+
> **Note:** 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).
31+
3032
## Verify Installation
3133

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

0 commit comments

Comments
 (0)