vtr_flow: added comment to add_tile script

Signed-off-by: Alessandro Comodi <[email protected]>

Author: acomodi

vtr_flow/scripts/add_tiles.py

@@ -1,4 +1,47 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
+
+"""
+This script is intended to modify the architecture description file to be compliant with
+the new format.
+
+It moves the top level pb_types attributes and tags to the tiles high-level tag.
+
+BEFORE:
+<complexblocklist>
+    <pb_type name="BRAM" area="2" height="4" width="1" capacity="1">
+        <input ... />
+        <input ... />
+        <input ... />
+        <output ... />
+        <output ... />
+        <output ... />
+        <interconnect ... />
+        <fc ... />
+        <pinlocations ... />
+        <switchblock_locations ... />
+    </pb_type>
+</complexblocklist>
+
+AFTER:
+<tiles>
+    <tile name="BRAM" area="2" height="4" width="1" capacity="1">
+        <interconnect ... />
+        <fc ... />
+        <pinlocations ... />
+        <switchblock_locations ... />
+    </tile>
+</tiles>
+<complexblocklist
+    <pb_type name="BRAM">
+        <input ... />
+        <input ... />
+        <input ... />
+        <output ... />
+        <output ... />
+        <output ... />
+    </pb_type>
+</complexblocklist>
+"""
 
 from lxml import etree as ET
 import argparse
@@ -21,7 +64,7 @@ def main():
     parser.add_argument(
         '--arch_xml',
         required=True,
-        help="Input arch.xml to specialized."
+        help="Input arch.xml that needs to be modified to move the top level pb_types to the `tiles` tag."
     )
 
     args = parser.parse_args()