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

86 lines
3.2 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".
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
if( NOT KICAD_BUILD_VERSION )
set( _wvh_version_str "no-vcs-found" )
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
Remove now obsolete bzr check
2016-09-15 05:43:12 +00:00
# Attempt to detect if we have a git repo and set the version string.
if( EXISTS "${SRC_PATH}/.git" )
Add git build version header support. * Add CreateGitVersionHeader.cmake to extract git version information to create the kicad version header. * Add check for .git folder in source path to trigger git version CMake macro.
2015-07-13 00:06:50 +00:00
message( STATUS "Using Git to determine build version string." )
include( ${CMAKE_MODULE_PATH}/CreateGitVersionHeader.cmake )
create_git_version_header( ${SRC_PATH} )
set( _wvh_version_str ${KICAD_BUILD_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()
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
else()
set( _wvh_version_str ${KICAD_BUILD_VERSION} )
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
set( _wvh_write_version_file ON )
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
# Compare the version argument against the version in the existing header file for a mismatch.
if( EXISTS ${OUTPUT_FILE} )
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
file( STRINGS ${OUTPUT_FILE} _current_version_str
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
REGEX "^#define[\t ]+KICAD_FULL_VERSION[\t ]+.*" )
string( REGEX REPLACE "^#define KICAD_FULL_VERSION \"([()a-zA-Z0-9 -.]+)\".*"
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
"\\1" _wvh_last_version "${_current_version_str}" )
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
# No change, do not write version.h
if( _wvh_version_str STREQUAL _wvh_last_version )
message( STATUS "Not updating ${OUTPUT_FILE}" )
set( _wvh_write_version_file OFF )
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()
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
if( _wvh_write_version_file )
message( STATUS "Writing ${OUTPUT_FILE} file with version: ${_wvh_version_str}" )
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
file( WRITE ${OUTPUT_FILE}
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__
#define KICAD_BUILD_VERSION \"${_wvh_version_str}\"
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
#define KICAD_BRANCH_NAME \"${KICAD_BRANCH_NAME}\"
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__ */
"
)
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()