Skip to content

Commit f234bb1

Browse files
oharboeclaude
andcommitted
Address KLayout docs review feedback
Remove speculative write_gds section — document it when relevant. Clarify why do-finish differs from finish (Make dependency vs recipe). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
1 parent cbadd29 commit f234bb1

File tree

1 file changed

+3
-18
lines changed

1 file changed

+3
-18
lines changed

flow/docs/KLayoutOptionalDependency.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,9 @@ Hint: KLayout is needed for GDS/DRC/LVS targets.
2828
## bazel-orfs Integration
2929

3030
bazel-orfs uses the `do-` prefixed targets which bypass Make's dependency
31-
management. The relevant targets follow the standard pattern:
32-
33-
- `do-finish` / `do-final` — runs the finish stage without GDS
34-
- `do-gds` — runs GDS generation (requires KLayout)
31+
management. `do-finish` / `do-final` only run the finish stage recipe
32+
itself, while `make finish` also pulls in the GDS target as a Make
33+
dependency. `do-gds` runs GDS generation separately (requires KLayout).
3534

3635
An `orfs_gds()` Bazel rule can call `do-gds` independently from
3736
`orfs_flow()`, making KLayout an optional toolchain dependency configured
@@ -58,17 +57,3 @@ These tests cover:
5857
- `.lyt` tech file generation (`test_generate_klayout_tech.py`)
5958
- DEF-to-GDS merging logic (`test_def2stream.py`)
6059
- DRC report conversion (`test_convertDrc.py`)
61-
62-
## Future: OpenROAD `write_gds` and KLayout Coexistence
63-
64-
OpenROAD has an unfinished `write_gds` command. When it is eventually
65-
completed, it would eliminate the KLayout dependency for GDS generation
66-
in many cases. However, KLayout support will live alongside `write_gds`
67-
until there is confidence that `write_gds` is robust and fully covers
68-
all current use cases.
69-
70-
Even then, non-public or future PDKs may have requirements that benefit
71-
from KLayout's mature GDS handling. Whether KLayout support stays in
72-
ORFS indefinitely remains to be seen. Once `write_gds` works robustly
73-
for all of today's use cases, extending it to cover future ones may
74-
turn out to be straightforward.

0 commit comments

Comments
 (0)