Add terminal colors and clarify elided hierarchy branches
This commit is contained in:
parent
ed1e0595bc
commit
28b7f10f6e
2 changed files with 421 additions and 39 deletions
18
docs/cli.md
18
docs/cli.md
|
|
@ -32,11 +32,15 @@ pheon hierarchy chip.gds --format mermaid --top CHIP
|
|||
normalized object within a cell. Coordinates are in database units. Rectangles
|
||||
show two corners, and longer vertex lists wrap across lines. References show
|
||||
the target and any array dimensions before the coordinates. Add `--records`
|
||||
to inspect the original record sequence, including timestamps.
|
||||
to inspect the original record sequence, including timestamps. In color
|
||||
output, the object dump highlights cell headings and layer numbers, and the
|
||||
record dump highlights record names.
|
||||
|
||||
`hierarchy` shows direct placement counts on references. Shared cells are
|
||||
marked where their contents appear earlier in the tree. Mermaid output is
|
||||
diagram source for a Mermaid renderer.
|
||||
`hierarchy` shows direct placement counts on references. `[subtree elided]`
|
||||
marks a repeated cell whose children were skipped. Repeated leaves show
|
||||
each parent's placement count without the marker. At the depth limit,
|
||||
`[children omitted]` marks a cell with further descendants. Mermaid
|
||||
output is diagram source for a Mermaid renderer.
|
||||
|
||||
## Compare revisions
|
||||
|
||||
|
|
@ -66,6 +70,12 @@ vertices show their width, vertex count, and vertex bounds in one line.
|
|||
Use `--format json` for details of individual objects and `--hierarchy` to see
|
||||
which parent cells are affected.
|
||||
|
||||
`diff` and `dump` use `--color auto` by default. Colors appear on supported
|
||||
terminals and are disabled when `NO_COLOR` is set or `TERM=dumb`. Use
|
||||
`--color=always` to keep colors in a pipe, for example
|
||||
`pheon diff before.gds after.gds --color=always | less -R`. Use
|
||||
`--color=never` for plain text. JSON reports and Mermaid diagram source stay plain.
|
||||
|
||||
For large unscoped diffs with substantial byte overlap, Pheon reuses parsed
|
||||
contents of matching cells. Cell timestamps and file offsets can differ.
|
||||
|
||||
|
|
|
|||
|
|
@ -28,6 +28,9 @@ indicates whether it was added or deleted. Keep the final `--` because Git appen
|
|||
its path and revision arguments after it. Put Pheon options such as `--top CHIP`
|
||||
or `--show-layer 1/0` before that marker.
|
||||
|
||||
The external driver also accepts `--color=always` before `--` to keep colors
|
||||
when its output goes through a pager that supports ANSI colors.
|
||||
|
||||
For an existing `diff=layout` attribute, put the configuration under
|
||||
`[diff "layout"]` instead. Attribute names only select a Git driver.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue