manage version through xmake, see more at DavidingPlus/nvmixfs#14

Author: DavidingPlus

src/config.h.in

@@ -0,0 +1,39 @@
+/**
+ * @file config.h.in
+ * @author DavidingPlus (davidingplus@qq.com)
+ * @brief 生成配置文件 config.h 的模板文件。请勿手动修改或格式化!!!
+ * @details 配置文件 config.h 通过 XMake 构建系统动态生成，对本文件进行任何修改或手动格式化操作都可能导致：
+ * - ${VERSION} 等占位符失效。
+ * - 版本号宏定义结构破坏。
+ *
+ * Copyright (c) 2025 电子科技大学 刘治学
+ *
+ */
+
+#ifndef _LINUX_KERNEL_MODULE_CONFIG_H_
+#define _LINUX_KERNEL_MODULE_CONFIG_H_
+
+
+/**
+ * @brief 完整版本号（X.Y.Z）。
+ */
+#define LINUX_KERNEL_MODULE_CONFIG_VERSION "${VERSION}"
+
+/**
+ * @brief 主版本号。
+ */
+#define LINUX_KERNEL_MODULE_CONFIG_VERSION_MAJOR ${VERSION_MAJOR}
+
+/**
+ * @brief 次版本号。
+ */
+#define LINUX_KERNEL_MODULE_CONFIG_VERSION_MINOR ${VERSION_MINOR}
+
+/**
+ * @brief 修订版本号。
+ * @details patch 和 alter 均可。Linux 内核的习惯是 patch，这里顺从 XMake 内置变量命名规则，即 alter。
+ */
+#define LINUX_KERNEL_MODULE_CONFIG_VERSION_ALTER ${VERSION_ALTER}
+
+
+#endif

src/main.c

@@ -1,8 +1,19 @@
+/**
+ * @file main.c
+ * @author DavidingPlus (davidingplus@qq.com)
+ * @brief 内核模块主程序入口文件。
+ *
+ * Copyright (c) 2025 电子科技大学 刘治学
+ *
+ */
+
 #include <linux/init.h>
 #include <linux/module.h>
 
+#include "config.h"
+
 
-MODULE_VERSION("1.0.0");
+MODULE_VERSION(LINUX_KERNEL_MODULE_CONFIG_VERSION);
 MODULE_LICENSE("Dual BSD/GPL");
 MODULE_AUTHOR("DavidingPlus");
 MODULE_DESCRIPTION("A Linux Kernel Module");

test/version-test.cpp

@@ -0,0 +1,34 @@
+#include <gtest/gtest.h>
+#include <string>
+
+#include "config.h"
+
+
+TEST(VersionTest, Test1)
+{
+    std::cout << LINUX_KERNEL_MODULE_CONFIG_VERSION << std::endl;
+
+    std::cout << LINUX_KERNEL_MODULE_CONFIG_VERSION_MAJOR << std::endl;
+
+    std::cout << LINUX_KERNEL_MODULE_CONFIG_VERSION_MINOR << std::endl;
+
+    std::cout << LINUX_KERNEL_MODULE_CONFIG_VERSION_ALTER << std::endl;
+}
+
+TEST(VersionTest, Test2)
+{
+    unsigned char major = '0' + LINUX_KERNEL_MODULE_CONFIG_VERSION_MAJOR;
+    unsigned char minor = '0' + LINUX_KERNEL_MODULE_CONFIG_VERSION_MINOR;
+    unsigned char alter = '0' + LINUX_KERNEL_MODULE_CONFIG_VERSION_ALTER;
+
+    std::string version;
+
+    version += major;
+    version += '.';
+    version += minor;
+    version += '.';
+    version += alter;
+
+
+    EXPECT_EQ(LINUX_KERNEL_MODULE_CONFIG_VERSION, version);
+}

xmake.lua

@@ -1,9 +1,18 @@
+set_project ("linux-kernel-module")
+set_version ("1.1.0")
+
+
 option ("linux-headers", {showmenu = true, description = "Set linux-headers path."})
 option ("with-gtest", {showmenu = true, description = "Whether to enable unit test by GTest.", default = false})
 
 
+set_configdir ("$(buildir)/config")
+add_configfiles ("src/config.h.in")
+
+add_includedirs ("$(buildir)/config/")
 add_includedirs ("src/")
 
+
 target ("linux-kernel-module")
     add_rules ("platform.linux.module")
     add_files ("src/*.c")