Merge remote-tracking branch 'private/master' into secure-gpl-log-less-misterious

Author: gudeh

.gitignore

@@ -87,7 +87,6 @@ perf.data.old
 # documentation specific
 docs/main
 docs/build
-GitGuide.md
 SupportedOS.md
 index2.md
 Manpage.md

README.md

@@ -90,7 +90,7 @@ Document for detailed local build from sources and installation steps found [her
   individual flows commands, see the documentation
   [here](https://openroad.readthedocs.io/en/latest/).
 - For details about automated flow setup, see ORFS docs
-  [here](https://openroad-flow-scripts.readthedocs.io/en/latest/user/GettingStarted.html).
+  [here](https://openroad-flow-scripts.readthedocs.io/en/latest/index2.html#getting-started-with-openroad-flow-scripts).
 - Flow tutorial to run the complete OpenROAD based flow from
   RTL-GDSII, see the tutorial
   [here](https://openroad-flow-scripts.readthedocs.io/en/latest/tutorials/FlowTutorial.html).

docs/contrib/GitGuide.md

@@ -0,0 +1,3 @@
+# Git Quickstart
+
+If you have reached this file on GitHub - please refer to this [link](https://openroad-flow-scripts.readthedocs.io/en/latest/contrib/GitGuide.html) for latest documentation.

docs/index.md

@@ -111,6 +111,7 @@ You can select a design using either of the following methods:
 2. Specify the design using the shell environment. For example:
 
 ```shell
+# Make sure you are in ./flow
 make DESIGN_CONFIG=./designs/nangate45/swerv/config.mk
 # or
 export DESIGN_CONFIG=./designs/nangate45/swerv/config.mk

docs/tutorials/FlowTutorial.md

@@ -829,7 +829,7 @@ The `gcd` design synthesis results for area and speed optimizations are shown be
 |-----------------------|--------------------------------------|--------------------------------------|
 | `Number of wires`     | 224                                  | 224                                  |
 | `Number of wire bits` | 270                                  | 270                                  |
-[O| `Number of cells`     | 234                                  | 234                                  |
+| `Number of cells`     | 234                                  | 234                                  |
 | `Chip area`           | 2083.248000                          | 2083.248000                          |
 | `Final Design Area`   | Design area 4295 u^2 6% utilization. | Design area 4074 u^2 6% utilization. |
 

docs/user/BuildLocally.md

@@ -53,3 +53,40 @@ Set up environment variables using `dev_env.sh`, then start Visual Studio Code.
 . ./dev_env.sh
 code tools/OpenROAD/
 ```
+
+## Build OpenROAD and run a few ORFS flows with Bazel
+
+Local use case:
+
+- Install Bazelisk and no other dependencies, no need to run `sudo ./setup.sh`
+- Modify & build OpenROAD
+- Test built OpenROAD with a few ORFS flows
+
+The Bazel support in OpenROAD and ORFS is work in progress and some Bazel experience is recommended before going spelunking in the Bazel builds.
+
+Contributions welcome!
+
+To build `designs/asap7/gcd:gcd_floorplan`:
+
+    cd flow
+    (cd ../tools/OpenROAD && bazel build :openroad -c opt) && bazelisk build designs/asap7/gcd:gcd_floorplan
+
+Or to run all flows currently available in Bazel
+
+    cd flow
+    (cd ../tools/OpenROAD && bazel build :openroad -c opt) && bazelisk build ...
+
+Note! ORFS uses the OpenROAD Bazel built binary in stop-gap way until OpenROAD has been switched to bzlmod, after which to build all flows becomes simpler as ORFS will build the requisite OpenROAD directly:
+
+    cd flow
+    bazelisk build ...
+
+ORFS uses [bazel-orfs](https://github.com/The-OpenROAD-Project/bazel-orfs) to implement the flow and gets some depedencies, like yosys, from the Docker image. Over time, all dependencies should be built with Bazel and the dependency on the ORFS Docker image will be phased out.
+
+### Upgrading MODULE.bazel with the latest bazel-orfs and ORFS Docker image
+
+Run:
+
+    bazelisk run @bazel-orfs//:bump
+
+Then commit MODULE.bazel and MODULE.bazel.lock.

docs/user/FlowVariables.md

@@ -235,8 +235,6 @@ configuration file.
 - [FLOORPLAN_DEF](#FLOORPLAN_DEF)
 - [HOLD_SLACK_MARGIN](#HOLD_SLACK_MARGIN)
 - [IO_CONSTRAINTS](#IO_CONSTRAINTS)
-- [IO_PLACER_H](#IO_PLACER_H)
-- [IO_PLACER_V](#IO_PLACER_V)
 - [MACRO_BLOCKAGE_HALO](#MACRO_BLOCKAGE_HALO)
 - [MACRO_PLACEMENT](#MACRO_PLACEMENT)
 - [MACRO_PLACEMENT_TCL](#MACRO_PLACEMENT_TCL)
@@ -249,7 +247,6 @@ configuration file.
 - [PDN_TCL](#PDN_TCL)
 - [PLACE_DENSITY](#PLACE_DENSITY)
 - [PLACE_DENSITY_LB_ADDON](#PLACE_DENSITY_LB_ADDON)
-- [PLACE_PINS_ARGS](#PLACE_PINS_ARGS)
 - [PLACE_SITE](#PLACE_SITE)
 - [REMOVE_ABC_BUFFERS](#REMOVE_ABC_BUFFERS)
 - [RESYNTH_AREA_RECOVER](#RESYNTH_AREA_RECOVER)

flow/.bazelrc

@@ -1,2 +1,2 @@
 build --incompatible_strict_action_env
-try-import %workspace%/.user-bazelrc
+try-import %workspace%/user.bazelrc

flow/.bazelversion

@@ -1 +1 @@
-7.5.0
+7.6.0

flow/.gitignore

@@ -2,5 +2,5 @@ settings.mk
 vars.sh
 vars.gdb
 vars.tcl
-.user-bazelrc
+user.bazelrc
 bazel-*