Merge pull request #1827 from The-OpenROAD-Project-staging/metrics-rules-table

genRuleFile.py print the metric updates as a Markdown table

Author: maliberty

flow/util/genRuleFile.py

@@ -182,6 +182,7 @@
 if len(period_list) != 1:
     print(f'[WARNING] Multiple clocks not supported. Will use first clock: {period_list[0]}.')
 
+change_str = ''
 for field, option in rules_dict.items():
     if field not in metrics.keys():
         print(f"[ERROR] Metric {field} not found in "
@@ -260,24 +261,29 @@
                 and rule_value != old_rule['value'] \
                 and compare(rule_value, old_rule['value']):
             UPDATE = True
-            print(f"[INFO] Tightening rule {field} "
-                  f"from {old_rule['value']} to {rule_value}.")
+            change_str += f"| {field} | {old_rule['value']} | "\
+                f"{rule_value} | Tighten |\n"
 
         if args.failing and not compare(metrics[field], old_rule['value']):
             UPDATE = True
-            print(f"[INFO] Updating failing rule {field} "
-                  f"from {old_rule['value']} to {rule_value}.")
+            change_str += f"| {field} | {old_rule['value']} | " \
+                f"{rule_value} | Failing |\n"
 
         if args.update and old_rule['value'] != rule_value:
             UPDATE = True
-            print(f"[INFO] Updating rule {field} "
-                  f"from {old_rule['value']} to {rule_value}.")
+            change_str += f"| {field} | {old_rule['value']} | "\
+                f"{rule_value} | Updating |\n"
 
         if not UPDATE:
             rule_value = old_rule['value']
 
     rules[field] = dict(value=rule_value, compare=option['compare'])
 
+if len(change_str) > 0:
+    print("| Metric | Old | New | Type |")
+    print("| ------ | --- | --- | ---- |")
+    print(change_str)
+
 with open(rules_file, 'w') as f:
     print('[INFO] writing', abspath(rules_file))
     json.dump(rules, f, indent=4)