vcs

提供对版本控制系统的支持。更多信息...

自从 Qbs 1.10

属性

vcs 模块通过 repoState 属性提供项目的存储库当前状态。默认情况下，也会生成一个 C 头文件，允许您直接从您自己的 C/C++ 源代码中检索存储库状态。这有助于在二进制文件中嵌入有关构建它们的存储库的确切状态的信息。

例如

#include <vcs-repo-state.h>
#include <iostream>

int main()
{
    std::cout << "I was built from " << VCS_REPO_STATE << std::endl;
}

在上面的示例中，创建了一个名为 vcs-repo-state.h 的头文件，其中定义了一个名为 VCS_REPO_STATE 的宏，它扩展为一个字符常量，描述存储库的当前状态。对于 Git，这将是当前 HEAD 的提交哈希。

headerFileName : string

要创建的 C 头文件的名称。

将其设置为 undefined 如果您不希望生成头文件。

默认值: "vcs-repo-state.h"

repoDir : string

存储库的根目录。

默认值: 顶级项目目录 (project.sourceDirectory)。

repoState : string

存储库的当前状态。

例如，在 Git 中，这是当前 HEAD 的提交哈希。

默认值: 未定义

toolFilePath : string

如果工具在您的本地安装中具有不寻常的名称，或者它位于构建环境的 PATH 中不存在的目录中，请设置此属性。

默认值: 与 type 相对应的版本控制工具的文件名。

type : string

项目中使用的版本控制系统。

目前支持以下值："git" 和 "svn"。

默认值: 自动检测