intel / intel/rohd

Add optional source annotation in generated outputs

Open
#547 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Dart
Stars
489
Forks
88
Avg merge
3d 23h
Merged PRs (30d)
10

Description

### Motivation

Information about the original Dart source code that generates some output (e.g. SystemVerilog) could theoretically be extracted during construction and annotated in the result, for example using `StackTrace`. This type of information could be valuable for debug and mapping of generated outputs back to their original ROHD representation.

### Desired solution

Add a way to annotate generated outputs with the original source code line in Dart.

### Alternatives considered

_No response_

### Additional details

The `StackTrace` functionality in Dart should be helpful here, but it might be tricky to figure out which lines in a trace are useful/relevant and which trace is most relevant to a generated line of verilog, since many pieces of code may contribute.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.