c - 我怎样才能让我的 C 代码自动打印出它的 Git 版本散列？

Question

有没有一种简单的方法来编写可以访问其 Git 版本哈希的 C 代码？

我用 C 语言编写软件以在实验室环境中收集科学数据。我的代码将它收集的数据记录在一个 .yaml 文件中以供以后分析。我的实验每天都在变化，我经常不得不修改代码。为了跟踪修订，我使用了一个 git 存储库。

我希望能够将 Git 修订散列作为注释包含在我的 .yaml 数据文件中。这样，我可以查看 .yaml 文件并确切地知道使用了哪些代码来生成该文件中显示的数据。有没有一种简单的方法可以自动执行此操作？

Answer 1

如果您使用的是基于 make 的构建，则可以将其放入 Makefile 中:

GIT_VERSION := "$(shell git describe --abbrev=4 --dirty --always --tags)"

(有关开关的作用，请参阅 man git describe)

然后将其添加到您的 CFLAGS 中:

-DVERSION=\"$(GIT_VERSION)\"

然后你可以直接在程序中引用版本，就好像它是#define:

printf("Version: %s\n", VERSION);

默认情况下，这只会打印一个缩写的 git commit id，但您可以选择使用以下内容标记特定版本:

git tag -a v1.1 -m "Release v1.1"

然后会打印出来:

Version: v1.1-2-g766d

这意味着，2 次提交超过 v1.1，git 提交 ID 以“766d”开头。

如果您的树中有未提交的更改，它将附加“-dirty”。

没有依赖项扫描，因此您必须执行明确的 make clean 以强制更新版本。这can be solved然而。

优点是它很简单，不需要任何额外的构建依赖项，如 perl 或 awk。我已将这种方法用于 GNU automake 和 Android NDK 构建。