Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cutter version overrides and git query fix #3422

Merged
merged 2 commits into from
Mar 11, 2025
Merged

Cutter version overrides and git query fix #3422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6c6eb2
Make version string more easily tweakable and fix git hash.
karliss Mar 10, 2025
3c942bf
Improve the git directory fix.
karliss Mar 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ option(CUTTER_PACKAGE_RZ_SILHOUETTE "Compile and install rz-silhouette during th
option(CUTTER_PACKAGE_JSDEC "Compile and install jsdec during install step." OFF)
set("CUTTER_QT" 6 CACHE STRING "Major QT version to use 5|6")
set_property(CACHE "CUTTER_QT" PROPERTY STRINGS 5 6)
option(CUTTER_INCLUDE_GIT_HASH "Include git hash in full version" ON)
set(CUTTER_VERSION_SUFFIX "" CACHE STRING "Can be used by packagers to differentiate multiple packages using same source, for example build number or presence of additional patches.")

if(NOT CUTTER_ENABLE_PYTHON)
set(CUTTER_ENABLE_PYTHON_BINDINGS OFF)
Expand All @@ -42,22 +44,25 @@ set(CUTTER_VERSION_PATCH 0)

set(CUTTER_VERSION "${CUTTER_VERSION_MAJOR}.${CUTTER_VERSION_MINOR}.${CUTTER_VERSION_PATCH}")

execute_process(COMMAND git log --pretty=format:'%h' -n 1
OUTPUT_VARIABLE GIT_REV
ERROR_QUIET)

if (CUTTER_INCLUDE_GIT_HASH)
execute_process(COMMAND git -C "${CMAKE_CURRENT_SOURCE_DIR}" --git-dir=.git log --pretty=format:'%h' -n 1
OUTPUT_VARIABLE GIT_REV
ERROR_QUIET)
endif()

# Check whether we got any revision (which isn't
# always the case, e.g. when someone downloaded a zip file
if ("${GIT_REV}" STREQUAL "")
set(CUTTER_VERSION_FULL "${CUTTER_VERSION}")
if (NOT CUTTER_INCLUDE_GIT_HASH OR "${GIT_REV}" STREQUAL "")
set(CUTTER_VERSION_FULL "${CUTTER_VERSION}${CUTTER_VERSION_SUFFIX}")
else()
execute_process(
COMMAND git rev-parse --abbrev-ref HEAD
COMMAND git -C "${CMAKE_CURRENT_SOURCE_DIR}" --git-dir=.git rev-parse --abbrev-ref HEAD
OUTPUT_VARIABLE GIT_BRANCH)
string(STRIP "${GIT_REV}" GIT_REV)
string(SUBSTRING "${GIT_REV}" 1 7 GIT_REV)
string(STRIP "${GIT_BRANCH}" GIT_BRANCH)
set(CUTTER_VERSION_FULL "${CUTTER_VERSION}-${GIT_BRANCH}-${GIT_REV}")
set(CUTTER_VERSION_FULL "${CUTTER_VERSION}${CUTTER_VERSION_SUFFIX}-${GIT_BRANCH}-${GIT_REV}")
endif()

project(Cutter VERSION "${CUTTER_VERSION}")
Expand Down
2 changes: 2 additions & 0 deletions docs/source/building.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,8 @@ If the names "Cutter" or "cutter" conflict with other packages or their content,
* ``CUTTER_ENABLE_PYTHON`` and ``CUTTER_ENABLE_PYTHON_BINDINGS`` it is recommended to turn on for complete user experience. May require manual path specification on distros with multiple python versions.
* ``CUTTER_ENABLE_GRAPHVIZ`` and ``CUTTER_ENABLE_KSYNTAXHIGHLIGHTING`` optional but nice to have since they are available on most distros.
* ``CUTTER_EXTRA_PLUGIN_DIRS`` use it to specify additional plugin search locations if distro packaging guidelines require you placing them in locations Cutter doesn't use by default.
* ``CUTTER_VERSION_SUFFIX`` can be used to differentiate multiple builds based on same upstream Cutter version, distro specific package build number and similar.
* ``CUTTER_INCLUDE_GIT_HASH=OFF`` By default cutter includes git commit hash in the full version string. If you are building from source tarrball or other source which isn't original git repository you might want to disable this.

Building on Windows
-------------------
Expand Down
Loading