Skip to content

Commit a6fa23f

Browse files
authored
Merge pull request verilog-to-routing#3119 from verilog-to-routing/read_init_place_doc
vpr command line doc: add --read_initial_place_file and clarify file formats for place options
2 parents 17fab9f + a23312d commit a6fa23f

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

doc/src/vpr/command_line_usage.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -416,9 +416,14 @@ Use the options below to override this default naming behaviour.
416416
.. option:: --write_placement_delay_lookup <file>
417417

418418
Writes the placement delay lookup to the specified file. Expects a file extension of either ``.capnp`` or ``.bin``.
419+
420+
.. option:: --read_initial_place_file <file>
421+
422+
Reads in the initial cluster-level placement (in :ref:`.place file format <vpr_place_file>`) from the specified file and uses it as the starting point for annealing improvement, instead of generating an initial placement internally.
423+
419424
.. option:: --write_initial_place_file <file>
420425

421-
Writes out the the placement chosen by the initial placement algorithm to the specified file.
426+
Writes out the clustered netlist placement chosen by the initial placement algorithm to the specified file, in :ref:`.place file format <vpr_place_file>`.
422427

423428
.. option:: --outfile_prefix <string>
424429

@@ -838,9 +843,9 @@ If any of init_t, exit_t or alpha_t is specified, the user schedule, with a fixe
838843

839844
Controls how the placer handles blocks (of any type) during placement.
840845

841-
* ``<file.place>``: A path to a file listing the desired location of blocks in the netlist.
846+
* ``<file.place>``: A path to a file listing the desired location of clustered blocks in the netlist.
842847

843-
This place location file is in the same format as a :ref:`normal placement file <vpr_place_file>`, but does not require the first two lines which are normally at the top of a placement file that specify the netlist file, netlist ID, and array size.
848+
This place location file is in the same format as a :ref:`.place file <vpr_place_file>`, but does not require the first two lines which are normally at the top of a placement file that specify the netlist file, netlist ID, and array size.
844849

845850
**Default:** ````.
846851

0 commit comments

Comments
 (0)