From f77755ea5dd55cd134d776f4805f6579557b08f6 Mon Sep 17 00:00:00 2001
From: Keith Rothman <537074+litghost@users.noreply.github.com>
Date: Fri, 5 Oct 2018 09:34:02 -0700
Subject: [PATCH] Add TODO to remove hack.

Signed-off-by: Keith Rothman <537074+litghost@users.noreply.github.com>
---
 fuzzers/005-tilegrid/generate.py | 4 +++-
 tools/fasm2frame.py              | 1 +
 tools/segprint2fasm.py           | 1 +
 utils/segprint.py                | 1 +
 4 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/fuzzers/005-tilegrid/generate.py b/fuzzers/005-tilegrid/generate.py
index d05e1282..fe7aea04 100644
--- a/fuzzers/005-tilegrid/generate.py
+++ b/fuzzers/005-tilegrid/generate.py
@@ -226,7 +226,9 @@ for segment_name in database["segments"].keys():
             # print(tile_type, offset)
             assert False
 
-
+# TODO: Migrate to new tilegrid format via library.  This data is added for
+# compability with unconverted tools.  Update tools then remove this data from
+# tilegrid.json.
 for tiledata in database['tiles'].values():
     if "segment" in tiledata:
         segment = tiledata['segment']
diff --git a/tools/fasm2frame.py b/tools/fasm2frame.py
index 495d5218..bf84b901 100755
--- a/tools/fasm2frame.py
+++ b/tools/fasm2frame.py
@@ -159,6 +159,7 @@ def run(f_in, f_out, sparse=False, debug=False):
                                        os.getenv("XRAY_DATABASE")), "r") as f:
         new_grid = json.load(f)
 
+    # TODO: Migrate to new tilegrid format via library.
     grid = {
             'tiles': new_grid,
             'segments': {}
diff --git a/tools/segprint2fasm.py b/tools/segprint2fasm.py
index ac5f248b..0a67c8e0 100755
--- a/tools/segprint2fasm.py
+++ b/tools/segprint2fasm.py
@@ -75,6 +75,7 @@ def run(f_in, f_out, sparse=False):
                                        os.getenv("XRAY_DATABASE")), "r") as f:
         new_grid = json.load(f)
 
+    # TODO: Migrate to new tilegrid format via library.
     grid = {
             'tiles': new_grid,
             'segments': {}
diff --git a/utils/segprint.py b/utils/segprint.py
index 256842ea..da745574 100755
--- a/utils/segprint.py
+++ b/utils/segprint.py
@@ -50,6 +50,7 @@ with open("%s/%s/tilegrid.json" % (os.getenv("XRAY_DATABASE_DIR"),
                                    os.getenv("XRAY_DATABASE")), "r") as f:
     new_grid = json.load(f)
 
+# TODO: Migrate to new tilegrid format via library.
 grid = {
         'tiles': new_grid,
         'segments': {}