From 9db53bb3d799e36e731d7b699b12f7bb118d7bbb Mon Sep 17 00:00:00 2001
From: Bea Healy <tabitha.healy@student.manchester.ac.uk>
Date: Mon, 1 Aug 2022 16:48:58 +0100
Subject: [PATCH] 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.
---
 doc/src/vpr/placement_constraints.rst | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/doc/src/vpr/placement_constraints.rst b/doc/src/vpr/placement_constraints.rst
index 84d86342443..f74f742de6e 100644
--- a/doc/src/vpr/placement_constraints.rst
+++ b/doc/src/vpr/placement_constraints.rst
@@ -15,16 +15,16 @@ A Constraints File Example
 	<vpr_constraints tool_name="vpr">
      		<partition_list>
 	  	<partition name="Part0">
-	       		<add_atom name_pattern="li354">
-	       		<add_atom name_pattern="alu*"> <!-- Regular expressions can be used to provide name patterns of the primitives to be added -->
-	       		<add_atom name_pattern="n877">
-	      		 <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 -->
-	       		<add_region x_low="7" y_low="3" x_high="7" y_high="6"
+	       		<add_atom name_pattern="li354"/>
+	       		<add_atom name_pattern="alu*"/> <!-- Regular expressions can be used to provide name patterns of the primitives to be added -->
+	       		<add_atom name_pattern="n877"/>
+	      		 <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 -->
+	       		<add_region x_low="7" y_low="3" x_high="7" y_high="6"/>
 	  	 </partition>
 	 	 <partition name="Part1">
-	       		<add_region x_low="3" y_low="3" x_high="7" y_high="7" subtile="0"> <!-- One specific location is specified -->
-	       		<add_atom name_pattern="n4917">
-	      		<add_atom name_pattern="n6010">
+	       		<add_region x_low="3" y_low="3" x_high="7" y_high="7" subtile="0"/> <!-- One specific location is specified -->
+	       		<add_atom name_pattern="n4917"/>
+	      		<add_atom name_pattern="n6010"/>
 	  	</partition>
      		</partition_list>
 	</vpr_constraints>
@@ -41,7 +41,7 @@ VPR has a specific XML format which must be used when creating a placement const
 
 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.
 
-.. note:: Use the VPR :option: `--read_vpr_constraints` to specify the VPR placement constraints file that is to be loaded. 
+.. note:: Use the VPR option :vpr:option:`--read_vpr_constraints` to specify the VPR placement constraints file that is to be loaded. 
 
 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.