Commit Graph

122 Commits

Author SHA1 Message Date
Matt Liberty
2939447bf1 Merge pull request #9649 from alokkumardalei-wq/docs_depenency
docs: Add DependencyInstaller.sh functionalities(-local and -prefix) to Build.md
2026-04-15 15:17:19 +00:00
Øyvind Harboe
cca60223ed Update docs/user/Bazel.md
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-04-14 18:17:30 +02:00
Øyvind Harboe
7d371a36ee bazel: add top-level aliases for install and tarfile
The install and tarfile targets were moved to //packaging/ to isolate
@rules_pkg loads from downstream consumers, but this broke the
user-facing //:install and //:tarfile targets. Add alias() rules at
the top level to restore the public API while keeping the implementation
in the packaging/ subdirectory.

Update documentation to use //:install and //:tarfile. Also fix
docs/user/Bazel.md which incorrectly listed rules_shell as a
dev_dependency (it is loaded in the root BUILD.bazel).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-04-14 18:12:35 +02:00
alokkumardalei-wq
5cd31076b7 docs: Update dependency install instructions to use setup.sh
Signed-off-by: alokkumardalei-wq <alokkumardalei2@gmail.com>
2026-04-14 09:19:02 +05:30
alokkumardalei-wq
8eecd0690c fix cmakeOptions eval bug and add missing help flag
Signed-off-by: alokkumardalei-wq <alokkumardalei2@gmail.com>
2026-04-14 09:09:27 +05:30
alokkumardalei-wq
f0795a1019 docs: Add DependencyInstaller help to Build.md and support -local/-prefix in Build.sh
Signed-off-by: alokkumardalei-wq <alokkumardalei2@gmail.com>
2026-04-14 09:07:45 +05:30
Sahil Jaiswal
218e898f8e build: Improve macOS build and dependency installation
ref #9895

- Add macOS venv setup documentation
- Improve Build.sh with better package validation and env config
- Update DependencyInstaller.sh for macOS (threads, icu4c, tcl-tk@8)
- Use pip instead of pipx

Signed-off-by: Sahil Jaiswal <jaiswalsahil7741@gmail.com>
2026-04-12 15:51:46 +05:30
Vitor Bandeira
4558a30fb7 Merge pull request #10008 from The-OpenROAD-Project-staging/bazel-docs
bazel:   fix Bazel target paths in install script and docs
2026-03-31 18:57:44 -03:00
Øyvind Harboe
0f5ef70df0 docs: fix stage list formatting in Bazel.md per review
Remove leading underscore from synth and use comma separators
for the list of ORFS stages, as suggested in PR #10011 review.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-03-31 23:12:35 +02:00
Øyvind Harboe
b2b9dbdfb0 docs: update bazel-orfs _deps targets to //:deps wrapper
bazel-orfs replaced per-stage _deps targets with a single //:deps
wrapper using --output_groups=deps. Update documentation to reflect
the new syntax while keeping tmp/ directory paths unchanged.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-03-31 23:12:32 +02:00
Vitor Bandeira
2464c8cb54 bazel: fix Bazel target paths in install script and docs
Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
2026-03-31 18:06:38 +00:00
Øyvind Harboe
8b75614c92 bazel: group dev deps, combine register_toolchains, docs split required vs suggested
Address PR #9827 review feedback:
- Group all dev_dependency bazel_dep entries into a separate section
  in MODULE.bazel for easier reasoning (hzeller)
- Combine two register_toolchains calls into one (gemini-code-assist)
- Split downstream MODULE.bazel docs into required and suggested
  sections, making toolchains_llvm optional (hzeller)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-03-24 11:44:34 +01:00
Øyvind Harboe
934733383a docs: document using OpenROAD as a dependency from another project
Add a section to Bazel.md covering the public API surface
(//:openroad and //:openroad_py), the minimal MODULE.bazel
boilerplate downstream consumers need (qt-bazel git_override,
toolchains_llvm configuration), and which deps are dev_dependency.

Signed-off-by: Claude Code <noreply@anthropic.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-03-19 12:13:52 +01:00
Øyvind Harboe
a967f32291 document whittle.py progress monitoring and Claude workflow
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-03-13 08:57:21 +01:00
Øyvind Harboe
477f4058d6 Merge remote-tracking branch 'origin/master' into HEAD
# Conflicts:
#	BUILD.bazel
2026-03-11 20:17:41 +01:00
Øyvind Harboe
4181d8ecb8 docs: update bazel-orfs deploy paths to use default tmp/ location
bazel-orfs deploy.tpl no longer accepts a positional path argument.
Files are now always placed in tmp/<package>/<name>/ under the
workspace root and deploy.tpl checks that tmp/ is in .gitignore
and tmp is in .bazelignore.

Update all documentation examples from the old syntax:
  bazelisk run foo_deps /tmp/place
to the current syntax:
  bazelisk run foo_deps
  tmp/<package>/foo_deps/make do-place

Also fix non-existent gcd_deps target to gcd_place_deps.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-03-08 11:44:15 +01:00
Matt Liberty
18031a8e35 Merge pull request #9668 from Pinata-Consulting/fix-faqs-link-extension
Fix missing .md extension in FAQS.md link
2026-03-06 07:24:07 +00:00
Øyvind Harboe
1238625860 Fix missing .md extension in FAQS.md link
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-03-06 07:44:15 +01:00
Friedrich Beckmann
54a0fe8e24 bazel: use pkg_tar for the install procedure
I updated the install procedure to use the pkg_tar
module. The install works as before, but now you
can also install optionally to another location.

Closes: #9635

Signed-off-by: Friedrich Beckmann <friedrich.beckmann@tha.de>
2026-03-06 06:54:32 +01:00
Øyvind Harboe
69bb3d22df etc: add whittle.py for delta-debugging .odb files
An alternative implementation of deltaDebug.py with a
standalone Python script (whittle.py) that delegates ODB manipulation
to small TCL scripts via `openroad -exit`. This works with any OpenROAD
build, even without Python compiled in.

deltaDebug.py is kept as-is during the transition period, but the
plan is to delete it once we're happy with whittle.py

Run with stock python3 — no extra packages needed beyond the standard
library.

Quick test using bazel-orfs gcd targets:

    bazelisk run //test/orfs/gcd:gcd_place_deps -- do-place ISSUE_TAG=test global_place_issue print-PWD
    mkdir whittle && cd whittle
    tar --strip-components=1 -xzf ../tmp/test/orfs/gcd/gcd_place_deps/_main/test/orfs/gcd/global_place_test.tar.gz
    sed -i 's/openroad -no_init/openroad -exit -no_init/g' \
            run-me-gcd-asap7-base.sh
    export PATH=$(pwd)/../../install/OpenROAD/bin:$PATH
    python3 ../etc/whittle.py \
            --persistence 2 --use_stdout \
            --error_string "      100 | " \
            --timeout 120 \
            --base_db_path \
                ../tmp/test/orfs/gcd/gcd_place_deps/_main/test/orfs/gcd/results/asap7/gcd/base/2_floorplan.odb \
            --step ./run-me-gcd-asap7-base.sh

After a minute or two:

```
Step 19, Nets level debugging, Insts 0, Nets 1, cut elements 1, timeout 2 minutes
[C]
Error Code found:       100 |
Removed 212 unused masters.
___________________________________
Resultant file is ../tmp/test/orfs/gcd/gcd_place_deps/_main/test/orfs/gcd/results/asap7/gcd/base/deltaDebug_base_result_2_floorplan.odb
Delta Debugging Done!
```

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-03-04 08:09:14 +01:00
Øyvind Harboe
6effc356fa bazel: fix duplicate version output and caching
- Change stamp = True to stamp = -1 so the genrule only stamps
  with --config=release (--stamp), not on every build. This keeps
  dev builds deterministic and cache-safe.
- Set OPENROAD_GIT_DESCRIBE to empty string instead of duplicating
  OPENROAD_VERSION (which caused "26Q1-... 26Q1-..." in the banner).
- Remove OPENROAD_GIT_DESCRIBE from OPENROAD_DEFINES to avoid macro
  redefinition with the genrule-generated Version.hh.
- Document version stamping in Bazel.md and Build.md.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-03-01 18:55:28 +01:00
Øyvind Harboe
4bee233fa1 bazel: add bazelisk run :install
Also: Apply suggestions from code review

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2026-01-28 12:08:19 +01:00
Øyvind Harboe
74ea0647b9 bazel: deltaDebug.py whittling donw instructions
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-10-25 09:14:39 +02:00
Øyvind Harboe
dbd9d6c83d bazel: add ORFS hacking use-case
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-10-03 15:47:15 +02:00
Sombrio
281117fd89 doc nitpick
Signed-off-by: Sombrio <sombrio@sombrasoft.dev>
2025-09-23 18:04:25 -03:00
Sombrio
94f372b728 add instructions to disable remote caching
Signed-off-by: Sombrio <sombrio@sombrasoft.dev>
2025-09-23 17:54:45 -03:00
Sombrio
c8054de218 PR comments
Signed-off-by: Sombrio <sombrio@sombrasoft.dev>
2025-09-23 17:49:01 -03:00
Sombrio
08c4c59835 updated bazel caching docs
Signed-off-by: Sombrio <sombrio@sombrasoft.dev>
2025-09-23 16:57:50 -03:00
JingrenWang
c60c7bf738 Refactor(Binary): Specify binary path
Signed-off-by: JingrenWang <wjrforcyber@163.com>
2025-09-12 07:05:54 +08:00
Øyvind Harboe
24110c55ba bazel: procedure to handle OpenROAD breaking changes to ORFS
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-07-30 07:37:57 +02:00
Øyvind Harboe
cde15b729f bazel: test GUI on github request use-case, review feedback
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-07-21 19:36:02 +02:00
Øyvind Harboe
3200012dee bazel: test GUI on github request use-case
These instructions are waiting for `:openroad` bazel targets to be OpenROAD
built with GUI support and `:openroad-cli` to be OpenROAD built
with CLI only support.

Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-07-21 10:25:16 +02:00
Øyvind Harboe
06fb213647 bazel: a blurb about configurations
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-07-10 08:31:33 +02:00
Øyvind Harboe
921976acbb bazel: document alternative way to configure caching
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-07-08 23:13:30 +02:00
Sombrio
e2aa43ed50 added bazel caching documentation
Signed-off-by: Sombrio <sombrio@sombrasoft.dev>
2025-07-02 23:12:00 -03:00
Øyvind Harboe
775ec1b63a docs: bazel bisect tips
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-06-30 14:44:46 +02:00
Øyvind Harboe
1397ca850c bazel: polish default use-case
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-06-27 12:17:46 +02:00
Øyvind Harboe
f0a4d8f2ac docs: bazel-orfs use-case, another way to skin the cat
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-06-20 16:23:28 +02:00
Øyvind Harboe
3b00365017 docs: bazel-orfs use-case
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-06-20 13:09:36 +02:00
Øyvind Harboe
4dcc184907 Merge remote-tracking branch 'origin/master' into HEAD 2025-06-18 20:48:56 +02:00
Matt Liberty
2d9e728675 Merge pull request #7608 from Pinata-Consulting/bazel-asan-tweak
Bazel asan tweak
2025-06-18 09:35:07 -07:00
Øyvind Harboe
fa16f07db5 bazel: more readme blurbs, review feedback
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-06-18 18:30:56 +02:00
Øyvind Harboe
87af1515fe bazel: more readme blurbs
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-06-18 17:28:07 +02:00
Øyvind Harboe
f3722f9eb1 bazel: document asan use-case
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-06-18 17:26:04 +02:00
Øyvind Harboe
e976337887 bazel: profiling use case documentation
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-06-18 08:31:11 +02:00
Øyvind Harboe
d13254a5f3 bazel: document asan use-case
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-06-18 07:37:53 +02:00
Øyvind Harboe
e527487548 bazel: document some use-cases, review feedback
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-06-17 21:36:46 +02:00
Øyvind Harboe
88718f29e1 bazel: document some use-cases
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-06-17 19:15:10 +02:00
Øyvind Harboe
344f765fd3 bazel: document cfg=exec/target of OpenROAD
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-06-16 21:31:15 +02:00
Øyvind Harboe
bf8ec64141 bazel: update READMEs
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2025-06-16 18:26:42 +02:00