c++ - 在 cmake 脚本中提供帮助信息

Question

我希望能够在 cmake 脚本中为我的最终用户提供有关构建的帮助信息(例如构建标志等)。有点像

cmake -G "Visual Studio 2010 Win64" projectpath --help

Configures the Foo project.
Sytnax:
cmake -G "Visual Studio 2010 Win64" projectpath --help [options]

where options are
-DNOTEST=1 disables test code

(ect)

有没有内置的方法可以做到这一点？

Answer 1

当您定义选项或缓存变量时，有一个指定帮助字符串的参数。用户看到该帮助字符串取决于他们运行 cmake 的方式。在 GUI 中，选项会在初始配置后显示，用户可以通过将鼠标悬停在上面来查看帮助文本。在命令行中，运行一次 cmake 后，命令 cmake -LH 将显示带有帮助文本的变量。见:

• option command documentation
• set command documentation