docs: Add Deprecated names of variables

docs/_templates/generate_configvar_docs/common_pdk_vars.md

@@ -20,19 +20,19 @@ ${"##"} PDK-Level
 These are variables that affect the entire PDK.
 
 
-| Variable Name | Type | Description | Units |
-| - | - | - | - |
+| Variable Name | Type | Description | Units | Deprecated Names |
+| - | - | - | - | - |
 %for var in pdk_variables:
-| `${var.name}`{#${var._get_docs_identifier()}} | ${var.type_repr_md(for_document=True)} | ${var.desc_repr_md()} | ${var.units or ""} |
+| `${var.name}`{#${var._get_docs_identifier()}} | ${var.type_repr_md(for_document=True)} | ${var.desc_repr_md()} | ${var.units or ""} | ${var.get_deprecated_names_md()|join("<br>")} |
 %endfor
 
 (univ_flow_cvars_scl)=
 ${"##"} SCL-Level
 
 These are variables that affect a specific standard-cell library.
 
-| Variable Name | Type | Description | Units |
-| - | - | - | - |
+| Variable Name | Type | Description | Units | Deprecated Names |
+| - | - | - | - | - |
 %for var in scl_variables:
-| `${var.name}`{#${var._get_docs_identifier()}} | ${var.type_repr_md(for_document=True)}  | ${var.desc_repr_md()} | ${var.units or ""} |
+| `${var.name}`{#${var._get_docs_identifier()}} | ${var.type_repr_md(for_document=True)}  | ${var.desc_repr_md()} | ${var.units or ""} | ${var.get_deprecated_names_md()|join("<br>")} |
 %endfor

docs/_templates/generate_configvar_docs/common_vars.md

@@ -12,8 +12,8 @@ can freely override these values.
 optional and behave accordingly.
 ```
 
-| Variable Name | Type | Description | Default | Units |
-| - | - | - | - | - |
+| Variable Name | Type | Description | Default | Units | Deprecated Names |
+| - | - | - | - | - | - |
 %for var in option_variables:
-| [`${var.name}`]{#${var._get_docs_identifier()}} | ${var.type_repr_md(for_document=True)} | ${var.desc_repr_md()} | `${var.default}` | ${var.units or ""} |
+| [`${var.name}`]{#${var._get_docs_identifier()}} | ${var.type_repr_md(for_document=True)} | ${var.desc_repr_md()} | `${var.default}` | ${var.units or ""} | ${var.get_deprecated_names_md()|join("<br>")} |
 %endfor

docs/source/faq.md

@@ -7,7 +7,7 @@
 
 ## General
 
-(faq-whats-openlane=)
+(faq-whats-openlane)=
 
 ### What is OpenLane?
 

openlane/config/variable.py

@@ -381,6 +381,14 @@ def type_repr_md(self, for_document: bool = False) -> str:  # pragma: no cover
             return repr_type(self.type).replace("｜", "｜<br />")
         return repr_type(self.type)
 
+    def get_deprecated_names_md(self) -> List[str]:
+        deprecated_names_md = []
+        for deprecated_name in self.deprecated_names:
+            if not isinstance(deprecated_name, str):
+                deprecated_name, _ = deprecated_name
+            deprecated_names_md.append(f"`{deprecated_name}`")
+        return deprecated_names_md
+
     def desc_repr_md(self) -> str:  # pragma: no cover
         """
         :returns: The description, but with newlines escaped for Markdown.
@@ -710,7 +718,7 @@ def _get_docs_identifier(self, parent: Optional[str] = None) -> str:
         return identifier
 
     def __hash__(self) -> int:
-        return hash((self.name, self.type, self.default))
+        return hash((self.name, str(self.type), str(self.default)))
 
     def __eq__(self, rhs: object) -> bool:
         if not isinstance(rhs, Variable):

openlane/flows/flow.py

@@ -419,14 +419,14 @@ def get_help_md(Self) -> str:  # pragma: no cover
 
                 #### Flow-specific Configuration Variables
 
-                | Variable Name | Type | Description | Default | Units |
-                | - | - | - | - | - |
+                | Variable Name | Type | Description | Default | Units | Deprecated Names |
+                | - | - | - | - | - | - |
                 """
             )
             for var in flow_config_vars:
                 units = var.units or ""
                 pdk_superscript = "<sup>PDK</sup>" if var.pdk else ""
-                result += f"| `{var.name}`{{#{var._get_docs_identifier(Self.__name__)}}}{pdk_superscript} | {var.type_repr_md()} | {var.desc_repr_md()} | `{var.default}` | {units} |\n"
+                result += f"| `{var.name}`{{#{var._get_docs_identifier(Self.__name__)}}}{pdk_superscript} | {var.type_repr_md()} | {var.desc_repr_md()} | `{var.default}` | {units} | {'<br>'.join(var.get_deprecated_names_md())} |\n"
             result += "\n"
 
         if len(Self.Steps):

openlane/steps/step.py

@@ -678,14 +678,14 @@ def get_help_md(
                 ({Self.id.lower()}-configuration-variables)=
                 #### Configuration Variables
 
-                | Variable Name | Type | Description | Default | Units |
-                | - | - | - | - | - |
+                | Variable Name | Type | Description | Default | Units | Deprecated Names |
+                | - | - | - | - | - | - |
                 """
             )
-            for var in Self.config_vars:
+            for var in set(Self.config_vars):
                 units = var.units or ""
                 pdk_superscript = "<sup>PDK</sup>" if var.pdk else ""
-                result += f"| `{var.name}`{{#{var._get_docs_identifier(Self.id)}}}{pdk_superscript} | {var.type_repr_md(for_document=True)} | {var.desc_repr_md()} | `{var.default}` | {units} |\n"
+                result += f"| `{var.name}`{{#{var._get_docs_identifier(Self.id)}}}{pdk_superscript} | {var.type_repr_md(for_document=True)} | {var.desc_repr_md()} | `{var.default}` | {units} | {'<br>'.join(var.get_deprecated_names_md())} |\n"
             result += "\n"
 
         result = (