add in docs that a build log file is generated

Signed-off-by: habibayassin <[email protected]>
antmicro · Jan 15, 2023 · 6c8cab6 · 6c8cab6
1 parent a4f921e
commit 6c8cab6
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report_with_orfs.yml b/.github/ISSUE_TEMPLATE/bug_report_with_orfs.yml
@@ -100,7 +100,9 @@ body:
     id: logs
     attributes:
       label: Relevant log output
-      description: Feel free to add any relevant log snippets to this section. This will be automatically formatted into code, so no need for backticks.
+      description: |
+        You can upload `build_openroad.log` file found in the main directory by dragging and dropping it below.
+        Feel free to add any other relevant log snippets to this section. This will be automatically formatted into code, so no need for backticks.
       render: shell
     validations:
       required: false

diff --git a/docs/contrib/DeveloperGuide.md b/docs/contrib/DeveloperGuide.md
@@ -2,7 +2,7 @@
 
 ## Building
 
-Instructions for building are available [here](../user/GettingStarted.md).
+Instructions for building are available [here](getting:started:setup:build).
 
 ## Logger
 

diff --git a/docs/user/BuildLocally.md b/docs/user/BuildLocally.md
@@ -27,6 +27,10 @@ cd OpenROAD-flow-scripts
 ./build_openroad.sh --local
 ```
 
+```{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).
+```
+
 ## Verify Installation
 
 The binaries should be available on your `$PATH` after setting up the

diff --git a/docs/user/GettingStarted.md b/docs/user/GettingStarted.md
@@ -21,7 +21,7 @@ To build the binaries and run `gcd` through the flow:
 Larger designs may require better hardware.
 
 ---
-
+(getting:started:setup:build)=
 ### Building and Installing the Software
 
 **WARNING**