[doc] update for using batch_mode

This commit is contained in:
tangxifan 2023-01-01 17:23:36 -08:00
parent 54c3b965f2
commit 882682c30a
1 changed files with 4 additions and 2 deletions

View File

@ -28,11 +28,13 @@ source
.. option:: --from_file
Specify the command stream comes from a file. When selected, the file will be parsed as a regular script following the OpenFPGA script file format. See details in :ref:openfpga_script_format
Specify the command stream comes from a file. When selected, the file will be parsed as a regular script following the OpenFPGA script file format. See details in :ref:`openfpga_script_format`
.. option:: --batch_mode
Enable batch mode when executing the script from a file. Valid only when ``--from_file`` is enabled
Enable batch mode when executing the script from a file. Valid only when ``--from_file`` is enabled.
.. note:: If you are sourcing a file when running OpenFPGA in script mode, please turn on the batch mode here. See details in :ref:`launch_openfpga_shell`
exit
~~~~