Merge pull request #2055 from verilog-to-routing/graphics_cmd_fix

Graphics Command Documentation Updated

Author: vaughnbetz

doc/src/vpr/command_line_usage.rst

@@ -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/
@@ -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.
 

vpr/src/base/read_options.cpp

@@ -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"