From 073161f5239643dcf1c099bcf654723135c73151 Mon Sep 17 00:00:00 2001 From: tangxifan Date: Tue, 12 Dec 2023 14:20:51 -0800 Subject: [PATCH] [doc] add new option --- docs/source/manual/openfpga_flow/run_fpga_task.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/source/manual/openfpga_flow/run_fpga_task.rst b/docs/source/manual/openfpga_flow/run_fpga_task.rst index 366e9bd23..094b3038c 100644 --- a/docs/source/manual/openfpga_flow/run_fpga_task.rst +++ b/docs/source/manual/openfpga_flow/run_fpga_task.rst @@ -29,9 +29,9 @@ Similarly ``regression/regression_quick`` expect following structure:: Running OpenFPGA Task: ~~~~~~~~~~~~~~~~~~~~~~ -At a minimum ``open_fpga_flow.py`` requires following command-line arguments:: +At a minimum ``run_fpga_task.py`` requires following command-line arguments:: - open_fpga_flow.py ... [] + run_fpga_task.py ... [] where: @@ -58,6 +58,12 @@ Command-line Options if any threads fail to execute successfully. It is mainly used to while performing regression test. +.. option:: --default_tool_path + + Specify the paths to tools as well as the keywords to extract QoR results from log files, when running this task. By default, the script will use the ``openfpga_flow/misc/fpgaflow_default_tool_path.conf``. + + .. note:: Please use absolute path!!! + .. option:: --test_run This option allows to debug OpenFPGA Task script