Kernel: Bake version information into the Kernel

This is done by generating a Kernel/Version.h header with major version, minor version, and git hash.
Author: https://github.com/kleinesfilmroellchen Commit: https://github.com/SerenityOS/serenity/commit/7c05eed487 Pull-request: https://github.com/SerenityOS/serenity/pull/15068 Issue: https://github.com/SerenityOS/serenity/issues/15071 Reviewed-by: https://github.com/ADKaster Reviewed-by: https://github.com/Hendiadyoin1 Reviewed-by: https://github.com/gmta Reviewed-by: https://github.com/linusg
2022-08-30 12:44:33 +02:00 · 2022-08-30 12:44:33 +02:00 · 7c05eed487 · 2024-07-17 05:49:27 +09:00
commit 7c05eed487
parent 92c203bba2
2 changed files with 50 additions and 0 deletions
--- a/Kernel/CMakeLists.txt
+++ b/Kernel/CMakeLists.txt
@ -410,6 +410,18 @@ set(ELF_SOURCES
    ../Userland/Libraries/LibELF/Validation.cpp
 )

+add_custom_command(
+    COMMAND "${SerenityOS_SOURCE_DIR}/Kernel/generate-version-file.sh" "${CMAKE_CURRENT_BINARY_DIR}/Version.h.tmp"
+    COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_CURRENT_BINARY_DIR}/Version.h.tmp" "${CMAKE_CURRENT_BINARY_DIR}/Version.h"
+    COMMAND "${CMAKE_COMMAND}" -E remove "${CMAKE_CURRENT_BINARY_DIR}/Version.h.tmp"
+    WORKING_DIRECTORY "${SerenityOS_SOURCE_DIR}"
+    COMMENT "Generating SerenityOS version information"
+    OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/Version.h"
+    VERBATIM
+)
+add_custom_target(generate_version_header ALL DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/Version.h")
+set(GENERATED_SOURCES "${CMAKE_CURRENT_BINARY_DIR}/Version.h")
+
 generate_state_machine(../Userland/Libraries/LibVT/StateMachine.txt ../Userland/Libraries/LibVT/EscapeSequenceStateMachine.h)

 set(VT_SOURCES
@ -437,6 +449,7 @@ set(SOURCES
 if (NOT "${SERENITY_ARCH}" STREQUAL "aarch64")
    set(SOURCES
        ${KERNEL_SOURCES}
+        ${GENERATED_SOURCES}
        ${SOURCES}
        ${EDID_SOURCES}
        ${ELF_SOURCES}
--- a/Kernel/generate-version-file.sh
+++ b/Kernel/generate-version-file.sh
@ -0,0 +1,37 @@
+#!/bin/sh
+
+set -e
+
+OUTPUT_FILE=$1
+
+if command -v git >/dev/null; then
+    if git status >/dev/null 2>&1; then
+        GIT_HASH=$( (git log --pretty=format:'%h' -n 1 | cut -c1-7) || true )
+        # There is at least one modified file as reported by git.
+        if git status --porcelain=v2 | head | grep -Ei '^1' >/dev/null; then
+            GIT_HASH="${GIT_HASH}-modified"
+        fi
+    else
+        GIT_HASH=unknown
+    fi
+else
+    GIT_HASH=unknown
+fi
+
+
+cat << EOF > "$OUTPUT_FILE"
+/*
+ * Automatically generated by Kernel/generate-version-file.sh
+ */
+
+#pragma once
+#include <AK/StringView.h>
+
+namespace Kernel {
+
+constexpr unsigned SERENITY_MAJOR_REVISION = 1;
+constexpr unsigned SERENITY_MINOR_REVISION = 0;
+constexpr StringView SERENITY_VERSION = "${GIT_HASH}"sv;
+
+}
+EOF