Skip to content

Commit 1ce602c

Browse files
authored
Updated documentation to make graphics command section more clear
1 parent 33c40f4 commit 1ce602c

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/src/vpr/command_line_usage.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ Graphics Options
119119
.. option:: --graphics_commands <string>
120120

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

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

153154
.. code-block:: none
154155
155-
save_graphics place.png; \
156+
"save_graphics place.png; \
156157
set_nets 1; save_graphics nets1.png;\
157158
set_nets 2; save_graphics nets2.png; set_nets 0;\
158159
set_cpd 1; save_graphics cpd1.png; \
159160
set_cpd 3; save_graphics cpd3.png; set_cpd 0; \
160161
set_routing_util 5; save_graphics routing_util5.png; \
161162
set_routing_util 0; \
162-
set_congestion 1; save_graphics congestion1.png;
163+
set_congestion 1; save_graphics congestion1.png;"
163164
164165
The above toggles various graphics settings (e.g. drawing nets, drawing critical path) and then saves the results to .png files.
165166

0 commit comments

Comments
 (0)