haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/CMakeModules/WriteVersionHeader.cmake

90 lines
3.4 KiB
CMake
Raw Normal View History

Minor version string generation changes. * Fix CMake macro create_bzr_version_header to always update version.h file whenever a repo change is found. Running `make rebuild_cache is no longer required. * Add new CMake function for writing version.h file. * Always use version.h file for build version string instead of meaningless hard coded date. * Only use bzr version string when build version is not defined at configuration time for stable release version strings. * Minor cleanup of FindBazaar.cmake. * Remove unnecessary version.h.cmake file.
2015-07-05 19:24:34 +00:00
#
# This program source code file is part of KICAD, a free EDA CAD application.
#
# Copyright (C) 2015 Wayne Stambaugh <stambaughw@verizon.net>
Update version string formatting after git migration It is no longer necessary (or sensible) to include a simulated bzr revision number, and we can reliably get a branch name now. Therefore, the new version strings look like: (2016-08-26 revision 67230ac)-master | | | | | branch name, "HEAD" if not on a branch, | | or "unknown" if no .git present | | | abbreviated commit hash, or no-git if no .git | present | date of commit, or date of build if no .git present Signed-off-by: Chris Pavlina <pavlina.chris@gmail.com>
2016-08-27 15:08:07 +00:00
# Copyright (C) 2015-2016 KiCad Developers, see AUTHORS.txt for contributors.
Minor version string generation changes. * Fix CMake macro create_bzr_version_header to always update version.h file whenever a repo change is found. Running `make rebuild_cache is no longer required. * Add new CMake function for writing version.h file. * Always use version.h file for build version string instead of meaningless hard coded date. * Only use bzr version string when build version is not defined at configuration time for stable release version strings. * Minor cleanup of FindBazaar.cmake. * Remove unnecessary version.h.cmake file.
2015-07-05 19:24:34 +00:00
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, you may find one here:
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# or you may search the http://www.gnu.org website for the version 2 license,
# or you may write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
#
Remove now obsolete bzr check
2016-09-15 05:43:12 +00:00
# Automagically create version header file if the version string was
# not defined during the build configuration. If
# CreateGitVersionHeader cannot determine the current repo version, a
# version.h file is still created with KICAD_BUILD_VERSION set to
# "no-vcs-found".
Minor version string generation improvements. Remove the KICAD_REPO_NAME option from the main cmake file and the generated config.h file since it is no longer used. Set the default branch name to "undefined" in CreateGitVersionHeader.cmake instead of the KICAD_REPO_NAME option. Remove generating KICAD_FULL_VERSION from CreateGitVersionHeader.cmake and add it to WriteVersionHeader.cmake so that the default settings and the new KiCadVersion.cmake definitions can be used to generate the full version string as well. Check to see if the branch name is set and only use the version to generate the full version string. This allows the use of the KiCad version cmake file to create a version only string like "4.0.4" with no trailing branch name. Change build_version.cpp to use the full version string rather than concatenating the version and branch strings.
2016-10-13 00:29:46 +00:00
include( ${CMAKE_MODULE_PATH}/KiCadVersion.cmake )
Minor version string generation changes. * Fix CMake macro create_bzr_version_header to always update version.h file whenever a repo change is found. Running `make rebuild_cache is no longer required. * Add new CMake function for writing version.h file. * Always use version.h file for build version string instead of meaningless hard coded date. * Only use bzr version string when build version is not defined at configuration time for stable release version strings. * Minor cleanup of FindBazaar.cmake. * Remove unnecessary version.h.cmake file.
2015-07-05 19:24:34 +00:00
Allow the contents of KiCadVersion.cmake to override git version. When the version string in KiCadVersion.cmake is set to something other than the default "no-vcs-found", it ignores the git version even if a .git folder exists in the source folder.
2016-10-14 13:43:38 +00:00
# Attempt to detect if we have a git repo and set the version string if
# the version wasn't set to something other than the default value in
# KiCadVersion.cmake.
if( _wvh_version_str STREQUAL "no-vcs-found" AND EXISTS "${SRC_PATH}/.git" )
Minor version string generation improvements. Remove the KICAD_REPO_NAME option from the main cmake file and the generated config.h file since it is no longer used. Set the default branch name to "undefined" in CreateGitVersionHeader.cmake instead of the KICAD_REPO_NAME option. Remove generating KICAD_FULL_VERSION from CreateGitVersionHeader.cmake and add it to WriteVersionHeader.cmake so that the default settings and the new KiCadVersion.cmake definitions can be used to generate the full version string as well. Check to see if the branch name is set and only use the version to generate the full version string. This allows the use of the KiCad version cmake file to create a version only string like "4.0.4" with no trailing branch name. Change build_version.cpp to use the full version string rather than concatenating the version and branch strings.
2016-10-13 00:29:46 +00:00
message( STATUS "Using Git to determine build version string." )
include( ${CMAKE_MODULE_PATH}/CreateGitVersionHeader.cmake )
create_git_version_header( ${SRC_PATH} )
Correctly fix version header generation to be rebuilt during make. * Use CMake add_custom_target() to run WriteVersionHeader.cmake as a command. * Modify WriteVersionHeader.cmake to be run as a command instead of a macro. * Add version header creation as a CMake common library build dependency. * Add cached CMake variable KICAD_BUILD_VERSION when build version is defined during configuration.
2015-07-10 18:47:59 +00:00
endif()
Minor version string generation changes. * Fix CMake macro create_bzr_version_header to always update version.h file whenever a repo change is found. Running `make rebuild_cache is no longer required. * Add new CMake function for writing version.h file. * Always use version.h file for build version string instead of meaningless hard coded date. * Only use bzr version string when build version is not defined at configuration time for stable release version strings. * Minor cleanup of FindBazaar.cmake. * Remove unnecessary version.h.cmake file.
2015-07-05 19:24:34 +00:00
Minor version string generation improvements. Remove the KICAD_REPO_NAME option from the main cmake file and the generated config.h file since it is no longer used. Set the default branch name to "undefined" in CreateGitVersionHeader.cmake instead of the KICAD_REPO_NAME option. Remove generating KICAD_FULL_VERSION from CreateGitVersionHeader.cmake and add it to WriteVersionHeader.cmake so that the default settings and the new KiCadVersion.cmake definitions can be used to generate the full version string as well. Check to see if the branch name is set and only use the version to generate the full version string. This allows the use of the KiCad version cmake file to create a version only string like "4.0.4" with no trailing branch name. Change build_version.cpp to use the full version string rather than concatenating the version and branch strings.
2016-10-13 00:29:46 +00:00
# If KICAD_BRANCH_NAME is empty, set KICAD_FULL_VERSION to just the build
# version rather than the concatenation of the build version and the branch
# name.
Bring back KICAD_REPO_NAME
2016-11-12 21:08:20 +00:00
if( KICAD_BUILD_VERSION AND KICAD_REPO_NAME )
set( KICAD_FULL_VERSION "${KICAD_BUILD_VERSION}-${KICAD_REPO_NAME}" )
elseif( KICAD_BUILD_VERSION )
Fix KICAD_BUILD_VERSION build option
2016-11-12 20:37:01 +00:00
set( KICAD_FULL_VERSION "${KICAD_BUILD_VERSION}" )
elseif( KICAD_BRANCH_NAME AND KICAD_GIT_BUILD_VERSION )
set( KICAD_FULL_VERSION "${KICAD_GIT_BUILD_VERSION}-${KICAD_BRANCH_NAME}" )
Minor version string generation improvements. Remove the KICAD_REPO_NAME option from the main cmake file and the generated config.h file since it is no longer used. Set the default branch name to "undefined" in CreateGitVersionHeader.cmake instead of the KICAD_REPO_NAME option. Remove generating KICAD_FULL_VERSION from CreateGitVersionHeader.cmake and add it to WriteVersionHeader.cmake so that the default settings and the new KiCadVersion.cmake definitions can be used to generate the full version string as well. Check to see if the branch name is set and only use the version to generate the full version string. This allows the use of the KiCad version cmake file to create a version only string like "4.0.4" with no trailing branch name. Change build_version.cpp to use the full version string rather than concatenating the version and branch strings.
2016-10-13 00:29:46 +00:00
else()
Fix KICAD_BUILD_VERSION build option
2016-11-12 20:37:01 +00:00
set( KICAD_FULL_VERSION "unknown" )
Minor version string generation improvements. Remove the KICAD_REPO_NAME option from the main cmake file and the generated config.h file since it is no longer used. Set the default branch name to "undefined" in CreateGitVersionHeader.cmake instead of the KICAD_REPO_NAME option. Remove generating KICAD_FULL_VERSION from CreateGitVersionHeader.cmake and add it to WriteVersionHeader.cmake so that the default settings and the new KiCadVersion.cmake definitions can be used to generate the full version string as well. Check to see if the branch name is set and only use the version to generate the full version string. This allows the use of the KiCad version cmake file to create a version only string like "4.0.4" with no trailing branch name. Change build_version.cpp to use the full version string rather than concatenating the version and branch strings.
2016-10-13 00:29:46 +00:00
endif()
Fix version header rewrite (happened too often) This commit also simplifies the rewrite logic slightly, removing the regex parsing. Bug introduced in: commit 47772e7ae379799701e7bc60522a44f7c62bc004 Author: Chris Pavlina <pavlina.chris@gmail.com> Date: Sun Sep 25 10:28:50 2016 -0400 cmake: rewrite version header when branch changes Before, only KICAD_BUILD_VERSION, which includes the hash but not the branch, was compared when deciding whether to regenerate kicad_build_version.h. This header also contains the branch name though, so we should compare both to address the case of two branches pointing at the same commit.
2016-09-27 15:40:12 +00:00
set( _wvh_new_version_text
Minor version string generation changes. * Fix CMake macro create_bzr_version_header to always update version.h file whenever a repo change is found. Running `make rebuild_cache is no longer required. * Add new CMake function for writing version.h file. * Always use version.h file for build version string instead of meaningless hard coded date. * Only use bzr version string when build version is not defined at configuration time for stable release version strings. * Minor cleanup of FindBazaar.cmake. * Remove unnecessary version.h.cmake file.
2015-07-05 19:24:34 +00:00
"/* Do not modify this file, it was automatically generated by CMake. */
/*
* Define the KiCad build version string.
*/
#ifndef __KICAD_VERSION_H__
#define __KICAD_VERSION_H__
cmake: rewrite version header when branch changes Before, only KICAD_BUILD_VERSION, which includes the hash but not the branch, was compared when deciding whether to regenerate kicad_build_version.h. This header also contains the branch name though, so we should compare both to address the case of two branches pointing at the same commit.
2016-09-25 14:28:50 +00:00
#define KICAD_FULL_VERSION \"${KICAD_FULL_VERSION}\"
Minor version string generation changes. * Fix CMake macro create_bzr_version_header to always update version.h file whenever a repo change is found. Running `make rebuild_cache is no longer required. * Add new CMake function for writing version.h file. * Always use version.h file for build version string instead of meaningless hard coded date. * Only use bzr version string when build version is not defined at configuration time for stable release version strings. * Minor cleanup of FindBazaar.cmake. * Remove unnecessary version.h.cmake file.
2015-07-05 19:24:34 +00:00
#endif /* __KICAD_VERSION_H__ */
Fix version header rewrite (happened too often) This commit also simplifies the rewrite logic slightly, removing the regex parsing. Bug introduced in: commit 47772e7ae379799701e7bc60522a44f7c62bc004 Author: Chris Pavlina <pavlina.chris@gmail.com> Date: Sun Sep 25 10:28:50 2016 -0400 cmake: rewrite version header when branch changes Before, only KICAD_BUILD_VERSION, which includes the hash but not the branch, was compared when deciding whether to regenerate kicad_build_version.h. This header also contains the branch name though, so we should compare both to address the case of two branches pointing at the same commit.
2016-09-27 15:40:12 +00:00
" )
set( _wvh_write_version_file ON )
# Only write the header if it has changed, to avoid rebuilds
if( EXISTS ${OUTPUT_FILE} )
file( READ ${OUTPUT_FILE} _wvh_old_version_text )
if( _wvh_old_version_text STREQUAL _wvh_new_version_text )
message( STATUS "Not updating ${OUTPUT_FILE}" )
set( _wvh_write_version_file OFF )
endif()
endif()
if( _wvh_write_version_file )
Bring back KICAD_REPO_NAME
2016-11-12 21:08:20 +00:00
message( STATUS "Writing ${OUTPUT_FILE} file with version: ${KICAD_FULL_VERSION}" )
Fix version header rewrite (happened too often) This commit also simplifies the rewrite logic slightly, removing the regex parsing. Bug introduced in: commit 47772e7ae379799701e7bc60522a44f7c62bc004 Author: Chris Pavlina <pavlina.chris@gmail.com> Date: Sun Sep 25 10:28:50 2016 -0400 cmake: rewrite version header when branch changes Before, only KICAD_BUILD_VERSION, which includes the hash but not the branch, was compared when deciding whether to regenerate kicad_build_version.h. This header also contains the branch name though, so we should compare both to address the case of two branches pointing at the same commit.
2016-09-27 15:40:12 +00:00
file( WRITE ${OUTPUT_FILE} ${_wvh_new_version_text} )
Minor version string generation changes. * Fix CMake macro create_bzr_version_header to always update version.h file whenever a repo change is found. Running `make rebuild_cache is no longer required. * Add new CMake function for writing version.h file. * Always use version.h file for build version string instead of meaningless hard coded date. * Only use bzr version string when build version is not defined at configuration time for stable release version strings. * Minor cleanup of FindBazaar.cmake. * Remove unnecessary version.h.cmake file.
2015-07-05 19:24:34 +00:00
Correctly fix version header generation to be rebuilt during make. * Use CMake add_custom_target() to run WriteVersionHeader.cmake as a command. * Modify WriteVersionHeader.cmake to be run as a command instead of a macro. * Add version header creation as a CMake common library build dependency. * Add cached CMake variable KICAD_BUILD_VERSION when build version is defined during configuration.
2015-07-10 18:47:59 +00:00
endif()
Minor version string generation changes. * Fix CMake macro create_bzr_version_header to always update version.h file whenever a repo change is found. Running `make rebuild_cache is no longer required. * Add new CMake function for writing version.h file. * Always use version.h file for build version string instead of meaningless hard coded date. * Only use bzr version string when build version is not defined at configuration time for stable release version strings. * Minor cleanup of FindBazaar.cmake. * Remove unnecessary version.h.cmake file.
2015-07-05 19:24:34 +00:00
Correctly fix version header generation to be rebuilt during make. * Use CMake add_custom_target() to run WriteVersionHeader.cmake as a command. * Modify WriteVersionHeader.cmake to be run as a command instead of a macro. * Add version header creation as a CMake common library build dependency. * Add cached CMake variable KICAD_BUILD_VERSION when build version is defined during configuration.
2015-07-10 18:47:59 +00:00
# There should always be a valid version.h file. Otherwise, the build will fail.
Rename the automatically generated version.h to kicad_build_version.h as a workaround to an issue in msys2: for a very obscure reason, version.h was added as dependency to most of .cpp files.
2015-11-24 10:05:34 +00:00
if( NOT EXISTS ${OUTPUT_FILE} )
Correctly fix version header generation to be rebuilt during make. * Use CMake add_custom_target() to run WriteVersionHeader.cmake as a command. * Modify WriteVersionHeader.cmake to be run as a command instead of a macro. * Add version header creation as a CMake common library build dependency. * Add cached CMake variable KICAD_BUILD_VERSION when build version is defined during configuration.
2015-07-10 18:47:59 +00:00
message( FATAL_ERROR "Configuration failed to write file ${OUTPUT_FILE}." )
endif()