Skip to content

Commit 2191a1e

Browse files
committed
Fixing required/optional argument formating in placement constraints file
1 parent 44bb51c commit 2191a1e

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

doc/src/vpr/placement_constraints.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -76,36 +76,36 @@ Partitions, Atoms, and Regions
7676
For example, to add all atoms ``alu[0]``, ``alu[1]``, and ``alu[2]`` to the partition ``Part0``, the user can use ``alu.*`` as the ``name_pattern`` in the ``<add_atom>`` tag.
7777

7878
.. arch:tag:: <add_region x_low="int" y_low="int" x_high="int" y_high="int" subtile="int" layer_low="int" layer_high="int">
79-
79+
8080
An ``<add_region>`` tag is used to add a region to the partition. A ``region`` is a rectangular area or cubic volume
8181
on the chip. A partition can contain any number of independent regions - the regions within one partition **must not**
8282
overlap with each other (in order to ease processing when loading in the file).
8383
An ``<add_region>`` tag has the following attributes.
8484

85-
:req_param x_low:
86-
The x value of the lower left point of the rectangle.
85+
:req_param x_low:
86+
The x value of the lower left point of the rectangle.
8787

88-
:req_param y_low:
89-
The y value of the lower left point of the rectangle.
88+
:req_param y_low:
89+
The y value of the lower left point of the rectangle.
9090

91-
:req_param x_high:
92-
The x value of the upper right point of the rectangle.
91+
:req_param x_high:
92+
The x value of the upper right point of the rectangle.
9393

94-
:req_param y_high:
95-
The y value of the upper right point of the rectangle.
94+
:req_param y_high:
95+
The y value of the upper right point of the rectangle.
9696

97-
:opt_param subtile:
98-
Each x, y location on the grid may contain multiple locations known as subtiles. This parameter is an optional value specifying the subtile location that the atom(s) of the partition shall be constrained to.
99-
This attribute is commonly used when constraining an atom to a specific location on the chip (e.g. an exact I/O location).
100-
It is legal to use with larger regions, but uncommon.
97+
:opt_param subtile:
98+
Each x, y location on the grid may contain multiple locations known as subtiles. This parameter is an optional value specifying the subtile location that the atom(s) of the partition shall be constrained to.
99+
This attribute is commonly used when constraining an atom to a specific location on the chip (e.g. an exact I/O location).
100+
It is legal to use with larger regions, but uncommon.
101101

102-
:opt_param layer_low:
103-
The lowest layer number that the region covers.
104-
**Default:** ``0``
102+
:opt_param layer_low:
103+
The lowest layer number that the region covers.
104+
**Default:** ``0``
105105

106-
:opt_param layer_high:
107-
The highest layer number that the region covers.
108-
**Default:** ``0``
106+
:opt_param layer_high:
107+
The highest layer number that the region covers.
108+
**Default:** ``0``
109109

110110

111111
In 2D architectures, ``layer_low`` and ``layer_high`` can be safely ignored as their default value is 0.

0 commit comments

Comments
 (0)