xmos / xcore_iot

Other
30 stars 39 forks source link

Fix XMOS_TOOL_PATH variable in the cmake toolchain file #279

Closed danielpieczko closed 2 years ago

danielpieczko commented 2 years ago

Noticed this while using the xcore_sdk toolchain in sw_avona. The environment variable that the tools sets is XMOS_TOOL_PATH instead of XMOS_TOOLS_PATH.

xmos-jmccarthy commented 2 years ago

This was the optional include added to allow someone to override the tools to use. The naming was intentional.

danielpieczko commented 2 years ago

Thank you for the correction, we can drop this change then if it's intentional.

xmos-jmccarthy commented 2 years ago

We might want to consider renaming it to avoid confusion.

By default the SDK will use the tools it finds on PATH. By passing cmake XMOS_TOOL_PATH, you can specify specific tools to use, potentially only useful to XMOS developers who test new versions of tools.

The XTC ENV will setup XMOS_TOOLS_PATH, which points to the tools version installed. The fact these are named similarly might bring about confusion.

keithm-xmos commented 2 years ago

@xmos-jmccarthy last paragraph has a typo I think. The XTC ENV will setup XMOS_TOOL_PATH, which points to the tools version installed. He is correct about the reason we have a different envar in the SDK. I will add a comment in the file so the next person is not also confused.