Skip to content

Commit 9db53bb

Browse files
committed
Update Placement Constraints documentation
Add missing close-tag and backslashes to example XML so that VPR accepts it, and correct the formatting so that the read_vpr_constraints option is displayed correctly.
1 parent 7989197 commit 9db53bb

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/src/vpr/placement_constraints.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ A Constraints File Example
1515
<vpr_constraints tool_name="vpr">
1616
<partition_list>
1717
<partition name="Part0">
18-
<add_atom name_pattern="li354">
19-
<add_atom name_pattern="alu*"> <!-- Regular expressions can be used to provide name patterns of the primitives to be added -->
20-
<add_atom name_pattern="n877">
21-
<add_region x_low="3" y_low="1" x_high="7" y_high="2"> <!-- Two rectangular regions are specified, together describing an L-shaped region -->
22-
<add_region x_low="7" y_low="3" x_high="7" y_high="6"
18+
<add_atom name_pattern="li354"/>
19+
<add_atom name_pattern="alu*"/> <!-- Regular expressions can be used to provide name patterns of the primitives to be added -->
20+
<add_atom name_pattern="n877"/>
21+
<add_region x_low="3" y_low="1" x_high="7" y_high="2"/> <!-- Two rectangular regions are specified, together describing an L-shaped region -->
22+
<add_region x_low="7" y_low="3" x_high="7" y_high="6"/>
2323
</partition>
2424
<partition name="Part1">
25-
<add_region x_low="3" y_low="3" x_high="7" y_high="7" subtile="0"> <!-- One specific location is specified -->
26-
<add_atom name_pattern="n4917">
27-
<add_atom name_pattern="n6010">
25+
<add_region x_low="3" y_low="3" x_high="7" y_high="7" subtile="0"/> <!-- One specific location is specified -->
26+
<add_atom name_pattern="n4917"/>
27+
<add_atom name_pattern="n6010"/>
2828
</partition>
2929
</partition_list>
3030
</vpr_constraints>
@@ -41,7 +41,7 @@ VPR has a specific XML format which must be used when creating a placement const
4141

4242
The file is passed as an input to VPR when running with placement constraints. When the file is read in, its information is used during the packing and placement stages of VPR. The hierarchy of the file is set up as follows.
4343

44-
.. note:: Use the VPR :option: `--read_vpr_constraints` to specify the VPR placement constraints file that is to be loaded.
44+
.. note:: Use the VPR option :vpr:option:`--read_vpr_constraints` to specify the VPR placement constraints file that is to be loaded.
4545

4646
The top level tag is the ``<vpr_constraints>`` tag. This tag contains one ``<partition_list>`` tag. The ``<partition_list>`` tag can be made up of an unbounded number of ``<partition>`` tags. The ``<partition>`` tags contains all of the detailed information of the placement constraints, and is described in detail below.
4747

0 commit comments

Comments
 (0)