Merge pull request #861 from zapta/main

Change the style of the apio.ini macros from {my-macro} to ${MY_MACRO}.

Author: zapta

apio/managers/project.py

@@ -364,13 +364,13 @@ def _parse_env_options(
         # -- Key/Value dict for macro expansion.
         macros = {
             # -- The ';' char.  (de-conflicted from ; comment)
-            "{semicolon}": ";",
+            "${SEMICOLON}": ";",
             # -- The '#' char.  (de-conflicted from # comment)
-            "{hash}": "#",
+            "${HASH}": "#",
             # -- The env name.
-            "{env-name}": env_name,
+            "${ENV_NAME}": env_name,
             # -- The relative path to env build directory (linux / style)
-            "{env-build}": (PROJECT_BUILD_PATH / env_name).as_posix(),
+            "${ENV_BUILD}": (PROJECT_BUILD_PATH / env_name).as_posix(),
         }
 
         # -- Select the env section by name.

docs/project-file.md

@@ -38,22 +38,23 @@ At runtime, apio select the env to use based using the following rules in decrea
 2. The value of the `default-env` option in the `[apio]` section, if exists.
 3. The first env that is listed in `apio.ini`.
 
-
 When apio determines the env to use, it collects its options
 from the `[common]` and the [env:name] section, with options in the `[env:name]` section
 having higher priority, and executes the command with the resolved set options.
 
-## Value macros
+## Project macros
 
-When processing env values, apio replaces the following macros with their
+When processing env values in apio.ini, apio replaces the following macros with their
 respective values.
 
-| MACRO_NAME    | VALUE                                                            |
-| :------------ | :--------------------------------------------------------------- |
-| `{semicolon}` | The character `;`                                                |
-| `{hash}`      | The character `#`                                                |
-| `{env-name}`  | The env name, e.g. `my-env`.                                     |
-| `{env-build}` | The posix path of the env build directory, e.g. `_build/my-env`. |
+| MACRO_NAME     | VALUE                                                            |
+| :------------- | :--------------------------------------------------------------- |
+| `${SEMICOLON}` | The character `;`                                                |
+| `${HASH}`      | The character `#`                                                |
+| `${ENV_NAME}`  | The env name, e.g. `my-env`.                                     |
+| `${ENV_BUILD}` | The posix path of the env build directory, e.g. `_build/my-env`. |
+
+> Hint: The `${SEMICOLON}` and `${HASH}` macros are provided to avoid interpretation as comment markers.
 
 ---
 
@@ -279,6 +280,6 @@ diagnosing Yosys related synthesis issues.
 board = alhambra-ii
 top-module = leds
 yosys-extra-options =
-  {semicolon} write_verilog {env-build}/yosys-synth.v
+  ${SEMICOLON} write_verilog ${ENV_BUILD}/yosys-synth.v
 ``
 ```

tests/unit_tests/managers/test_project.py

@@ -163,9 +163,9 @@ def test_macro_expansion(apio_runner: ApioRunner, capsys: LogCaptureFixture):
             "[env:default]": {
                 "board": "alhambra-ii",
                 "top-module": "my_top_module",
-                "constraint-file": " {semicolon} value ",
-                "yosys-extra-options": "  k1={env-build}/v1  k2=v2; \n ; "
-                "Comment \n k3=v3{hash} {env-name}\n\n",
+                "constraint-file": " ${SEMICOLON} value ",
+                "yosys-extra-options": "  k1=${ENV_BUILD}/v1  k2=v2; \n ; "
+                "Comment \n k3=v3${HASH} ${ENV_NAME}\n\n",
             }
         },
         env_arg=None,