了解如何使用shell实用程序“direnv”在West工作区中工作时自动激活Zephyr构建环境
扫描二维码
随时随地手机看文章
我最近为Nordic Thingy:91 X设置了一个nRF Connect SDK (NCS)命令行开发环境,其中包括下载和安装工具链和SDK代码。
当我设置好一切后,我发现了如何使用shell实用工具来通过CLI在West工作区中工作时自动激活Zephyr构建环境。一旦配置了direnv,当将目录更改为工作空间时,将在shell中自动激活构建环境。类似地,当离开工作区目录时,构建环境将自动停用。
如果您像我一样,并且您的大脑是筛子,那么这将使您不必记住并手动键入命令来激活python虚拟环境,并获取所需的脚本,以确保正确设置Zephyr环境变量。
在这个项目中,我将描述如何为Nordic的nRF Connect SDK (NCS)以及“vanilla”上游Zephyr RTOS West工作区设置这个shell自动化。
在我们深入项目之前,请注意:不幸的是,direnv只能在类unix操作系统(macOS, Linux等)上工作,并且需要支持shell (bash, zsh, tcsh, fish, elvish, powershell, murex, nushell)。对不起,Windows的朋友们!
nRF Connect SDK (NCS)示例
在最新版本的nRF Connect SDK中,Nordic建议使用他们的nRF Util CLI工具来管理Nordic提供的工具链包的安装。
nRF Util (nrfutil)被描述为“北欧产品的统一命令行实用工具”,通过一组可安装和可升级的子命令提供了广泛的功能。具体来说,toolchain-manager命令可用于搜索、安装和卸载工具链。
除了管理工具链之外,toolchain-manager命令还提供env和launch子命令来激活shell中的特定工具链环境。
例如,您可以使用nrfutil toolchain-manager env命令来显示配置工具链环境所需的环境变量:
在安装nRF Connect SDK文档中,Nordic建议使用以下命令在子shell中激活工具链:
不幸的是,当启动这个子shell时,任何shell配置文件(例如。bashrc)都会被跳过:
生成的shell由shell环境变量决定。尝试在不运行任何配置文件(例如。bashrc)的情况下生成shell,因为这些文件可能(潜在地)弄乱环境。
结果,如下图所示,在启动新的子shell时,我的自定义shell提示符和其他shell配置被忽略:
作为替代方案,nrfutil toolchain-manager env——As -script命令可以输出一个脚本,该脚本设置与launch——shell子命令相同的环境:
通过在该命令的输出上运行eval,我们可以有效地激活当前shell中的工具链构建环境(无需启动新的子shell):
不幸的是,我永远也记不住这个命令……
用direnv自动化它
如果工具链在我们进入West工作区时自动激活,在我们离开工作区时自动停用,那就太好了。
对我们来说幸运的是,direnv是一个通用的shell实用程序,旨在支持这种类型的行为。
在每个提示符之前,direnv检查当前目录和父目录中是否存在.envrc文件(也可以选择存在.env文件)。如果该文件存在(并且经过授权),则将其加载到bash子shell中,然后由direnv捕获所有导出的变量,然后使其可用于当前shell。
首先,我们需要安装direnv shell实用程序。
接下来,在West工作区的根目录下,我们需要添加一个.envrc文件,包含以下行:
现在,当我们进入工作区目录时,direnv将自动运行上面的命令,并将生成的构建环境变量导出到当前shell中。您应该看到如下消息:
我们可以检查以验证环境变量是否设置正确。例如:
万岁,成功了!
出于安全考虑,除非明确允许,否则direnv不会自动从.envrc脚本加载更改。因此,您可能会在第一次进入工作区时看到如下错误:
你只需要运行一次direnv allow来允许它运行。
上游Zephyr示例
我们还可以使用direnv来自动激活“vanilla”Zephyr RTOS工作区的构建环境。
如果你通过命令行使用West工作区,你可能习惯输入这样的东西来激活构建环境:
和上面的NCS示例一样,我们可以在West工作空间的根目录下添加一个.envrc文件,如下所示:
现在,只要您进入Zephyr -workspace/目录,python虚拟环境和Zephyr环境脚本就会自动激活!
本文编译自hackster.io