Repository navigation
Netlist review threads (async, in git) - #34
Merged
Merged
Conversation
A review is a directory committed with the design (docs/review_format.md): threads anchored on netlist objects by naja ids only, one new file per write so branches merge without conflicts, and the netlist each thread was written on stored as a content-addressed naja-if snapshot. - review.py: the format, anchor location by ids (names only at write time), resolution (exact / other_snapshot / unresolved), snapshots. - ViewerSession pushes review_response after each root load and every write; review_add_thread / review_add_event requests. - naja-schematic --review DIR [--author NAME]; --review alone opens the latest snapshot (--snapshot ID picks one). review= on show()/Schematic. - Requires najaeda 0.7.34 (SNLDesign.getNetByID, SNLNet.getID).
- ReviewStore parses the host's review_response and matches threads to objects by ids only (instance id_path, term/net id, bit), and only those the host resolved exact on the loaded design. - Review tab: open/all filter, a thread's comments, Reply, Resolve / Won't Fix / Reopen, Select / Show in Schematic, the snapshot id of a thread written on another netlist. Selecting a thread keeps the tab in front. - "Add Comment..." in the tree's instance/pin/net menus and the schematic's box/pin menus (writable hosts only); [n] open threads after tree rows and a numbered badge on schematic boxes, drawn through the painter. - nets_response entries carry net_id (both backends), so a net row can anchor a thread.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Lets people (and agents) leave findings on a netlist and pass them to each other asynchronously, through git. A review is a directory committed next to the design; see
docs/review_format.md.Format
threads/<id>/thread.json, then one file per comment or status change); no file is ever rewritten, so two branches commenting on the same thread merge cleanly.id_path, term/net id, bus bit); names are stored only as labels.other_snapshot): no name-based guessing.naja-schematic --review DIRalone opens the latest snapshot (--snapshot IDpicks one).Python host
review.py: format, anchor location, resolution, snapshots.ViewerSessionpushesreview_responseafter each root load and every write;review_add_thread/review_add_eventrequests.naja-schematic --review DIR [--author NAME],review=onshow()/Schematic.SNLDesign.getNetByID,SNLNet.getID).Viewer
[n]open threads after tree rows, numbered badge on schematic boxes (also in SVG exports).nets_responseentries carrynet_id(both backends).Not in this PR
LocalSNLProvider) review support: the Review tab there says no review is loaded.Testing
pytest python/tests: 177 passed, 1 skipped.ctest: 244 passed (newReviewStoreTest,ReviewViewTest, net_id checks).