Skip to content

Updated graphics.rst (Documentation) #2326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 13, 2023

Conversation

Meet-Patel2580
Copy link
Contributor

@Meet-Patel2580 Meet-Patel2580 commented May 29, 2023

Updated the documentation for VPR graphics by adding new images of the UI as well as fixing grammatical errors and descriptions of the locations of various buttons.

Description

Related Issue

Motivation and Context

The existing documentation displayed an older version of the user interface and was required to be updated with newer images as well as an updated description of how to use certain features.

How Has This Been Tested?

Types of changes

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

Updated the documentation for VPR graphics by adding new images of the UI as well as fixing grammatical errors and descriptions of the locations of various buttons.
Created an Images folder to hold images of the documentation.
@vaughnbetz
Copy link
Contributor

Looks good; one suggested change. Then ping me to merge. Right after merging, check the web page to make sure all the images show up.

@vaughnbetz
Copy link
Contributor

vaughnbetz commented Jun 6, 2023

Another item to investigate (but should be another issue): can we show only the highlighted nets (fanin and fanout of selected block)? I think we should rename "None" to "Highlighted Only" and then made placement draw the highlighted cluster nets / highlighted primitive nets (depending on what was clicked on).

@vaughnbetz
Copy link
Contributor

Should also change the code to have "Set Net Transparency" --> Net Transparency (0 - 255)

Updated the toggle options to Cluster Nets and Primitive Nets from Nets and Logical Connections respectively.
@github-actions github-actions bot added the VPR VPR FPGA Placement & Routing Tool label Jun 9, 2023
Updated intra_logic_block.cpp to match the new name of the global variable "Draw_logical_connections" to "draw_primitive_nets".
Updated VPR documentation due to a change in the "Toggle Nets" dropdown list to better describe the options. Added updated image as well.
Changed "Set Net Transparency" to "Net Transparency (0 - 255)"
@Meet-Patel2580
Copy link
Contributor Author

All suggested changes made. @vaughnbetz , You may now merge this PR, and I will check right after to make sure the images on the documentation are showing up properly.

@vaughnbetz
Copy link
Contributor

Thanks Meet.

@vaughnbetz vaughnbetz merged commit 02d433d into verilog-to-routing:master Jun 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
VPR VPR FPGA Placement & Routing Tool
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants