在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