Graphics Command Documentation Updated

[jmah76]

Description

Documentation for running graphics commands was made more clear.

Related Issue

Running any graphics command examples from the documentation, such as sample command $VTR_ROOT/vpr/vpr $VTR_ROOT/vtr_flow/arch/timing/EArch.xml $VTR_ROOT/vtr_flow/benchmarks/blif/tseng.blif --route_chan_width 100 --analysis --save_graphics on --graphics_commands save_graphics place.png, did not work. The documentation neglected to mention that graphics commands must be surrounded by quotation marks, as argparse considers space filled strings as multiple arguments even if the user intended it to be just one.

A fix to Issue #2001.

How Has This Been Tested?

Ran
$VTR_ROOT/vpr/vpr $VTR_ROOT/vtr_flow/arch/timing/EArch.xml $VTR_ROOT/vtr_flow/benchmarks/blif/tseng.blif --route_chan_width 100 --analysis --save_graphics on --graphics_commands save_graphics place.png; set_nets 1; save_graphics nets1.png; set_nets 2; save_graphics nets2.png; set_nets 0;
and
$VTR_ROOT/vpr/vpr $VTR_ROOT/vtr_flow/arch/timing/EArch.xml $VTR_ROOT/vtr_flow/benchmarks/blif/tseng.blif --route_chan_width 100 --analysis --save_graphics on --graphics_commands "save_graphics place.png; set_nets 1; save_graphics nets1.png; set_nets 2; save_graphics nets2.png; set_nets 0;".

The former returns

Unexpected command-line argument 'place.png' 

usage: vpr architecture circuit [--pack] [--place] [--route] [--analysis]
       [--disp {on, off}] [--save_graphics {on, off}]
       [--graphics_commands GRAPHICS_COMMANDS] [-h] [--version]
       [--device DEVICE_NAME] [-j NUM_WORKERS] [--timing_analysis {on, off}]
       [--disable_errors DISABLE_ERRORS] [--suppress_warnings SUPPRESS_WARNINGS]
       [--route_chan_width CHANNEL_WIDTH] [OTHER_OPTIONS ...]
set_nets: command not found
save_graphics: command not found
set_nets: command not found
save_graphics: command not found
set_nets: command not found

while the latter works.

Checklist:

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

[vaughnbetz]

Looks good; thanks.