Skip to content

Graphics Command Documentation Updated #2055

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.

Sign up for GitHub

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 4 commits into from
Jun 9, 2022
Merged

Graphics Command Documentation Updated #2055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d22193d
Changed desc. of --graphics-commands to mention quotations
jmah76 Jun 8, 2022
33c40f4
Fixed typo
jmah76 Jun 8, 2022
1ce602c
Updated documentation to make graphics command section more clear
jmah76 Jun 8, 2022
d131e14
Fixed typo.
jmah76 Jun 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions doc/src/vpr/command_line_usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ Graphics Options
.. option:: --graphics_commands <string>

A set of semi-colon seperated graphics commands.
Graphics commands must be surrounded by quotation marks (e.g. --graphics_commands "save_graphics place.png;")

* save_graphics <file>
Saves graphics to the specified file (.png/.pdf/
Expand Down Expand Up @@ -152,14 +153,14 @@ Graphics Options

.. code-block:: none

save_graphics place.png; \
"save_graphics place.png; \
set_nets 1; save_graphics nets1.png;\
set_nets 2; save_graphics nets2.png; set_nets 0;\
set_cpd 1; save_graphics cpd1.png; \
set_cpd 3; save_graphics cpd3.png; set_cpd 0; \
set_routing_util 5; save_graphics routing_util5.png; \
set_routing_util 0; \
set_congestion 1; save_graphics congestion1.png;
set_congestion 1; save_graphics congestion1.png;"

The above toggles various graphics settings (e.g. drawing nets, drawing critical path) and then saves the results to .png files.

Expand Down
3 changes: 2 additions & 1 deletion vpr/src/base/read_options.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1277,7 +1277,8 @@ argparse::ArgumentParser create_arg_parser(std::string prog_name, t_options& arg

gfx_grp.add_argument(args.graphics_commands, "--graphics_commands")
.help(
"A set of semi-colon seperated graphics commands.\n"
"A set of semi-colon seperated graphics commands. \n"
"Commands must be surrounded by quotation marks (e.g. --graphics_commands \"save_graphics place.png\")\n"
" Commands:\n"
" * save_graphics <file>\n"
" Saves graphics to the specified file (.png/.pdf/\n"
Expand Down