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

81 lines
3.0 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.
#
Change how version strings are generated. Git is always used to generate the KiCad version string using the command `git describe --dirty`. This gives a more concise and accurate version string than the previous method. When git is not available, the version string defaults to the value defined in KiCadVersion.cmake. It is imperative that moving forward that the default version string be updated the commit following a git tag so that when git is not available, the last known commit following a git tag will at least give some usable information about which development branch of KiCad was used for a build.
2018-02-12 21:04:48 +00:00
# Copyright (C) 2015 Wayne Stambaugh <stambaughw@gmail.com>
# Copyright (C) 2015-2018 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
Change how version strings are generated. Git is always used to generate the KiCad version string using the command `git describe --dirty`. This gives a more concise and accurate version string than the previous method. When git is not available, the version string defaults to the value defined in KiCadVersion.cmake. It is imperative that moving forward that the default version string be updated the commit following a git tag so that when git is not available, the last known commit following a git tag will at least give some usable information about which development branch of KiCad was used for a build.
2018-02-12 21:04:48 +00:00
# not defined during the build configuration. If CreateGitVersionHeader
# cannot determine the current repo version, a version.h file is still
# created with KICAD_VERSION set in KiCadVersion.cmake.
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
Change how version strings are generated. Git is always used to generate the KiCad version string using the command `git describe --dirty`. This gives a more concise and accurate version string than the previous method. When git is not available, the version string defaults to the value defined in KiCadVersion.cmake. It is imperative that moving forward that the default version string be updated the commit following a git tag so that when git is not available, the last known commit following a git tag will at least give some usable information about which development branch of KiCad was used for a build.
2018-02-12 21:04:48 +00:00
# Always use git if it's available to determine the version string.
message( STATUS "Using Git to determine build version string." )
include( ${CMAKE_MODULE_PATH}/CreateGitVersionHeader.cmake )
create_git_version_header( ${SRC_PATH} )
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
Change how version strings are generated. Git is always used to generate the KiCad version string using the command `git describe --dirty`. This gives a more concise and accurate version string than the previous method. When git is not available, the version string defaults to the value defined in KiCadVersion.cmake. It is imperative that moving forward that the default version string be updated the commit following a git tag so that when git is not available, the last known commit following a git tag will at least give some usable information about which development branch of KiCad was used for a build.
2018-02-12 21:04:48 +00:00
# $KICAD_VERSION will always be set to something. Even if it is the default
# value set in KiCadVersion.cmake
Version string improvements. Define empty string variable KICAD_BRANCH_NAME that can be used as an optional version string element. When git is used to build the version string, this variable is set to the git branch name. It can also be defined at configuration time as an optional string appended to the $KICAD_VERSION variable. Define empty string variable KICAD_VERSION_EXTRA that can be set by the user at configuration. The variables KICAD_BRANCH_NAME and KICAD_VERSION_EXTRA are only appended to KICAD_VERSION if they are set. Otherwise, only KICAD_VERSION is uses as the version string. Update the developer building from source document to reflect the changes.
2016-11-24 17:37:34 +00:00
set( KICAD_VERSION_FULL "${KICAD_VERSION}" )
# Optional user version information defined at configuration.
if( KICAD_VERSION_EXTRA )
set( KICAD_VERSION_FULL "${KICAD_VERSION_FULL}-${KICAD_VERSION_EXTRA}" )
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__
Version string improvements. Define empty string variable KICAD_BRANCH_NAME that can be used as an optional version string element. When git is used to build the version string, this variable is set to the git branch name. It can also be defined at configuration time as an optional string appended to the $KICAD_VERSION variable. Define empty string variable KICAD_VERSION_EXTRA that can be set by the user at configuration. The variables KICAD_BRANCH_NAME and KICAD_VERSION_EXTRA are only appended to KICAD_VERSION if they are set. Otherwise, only KICAD_VERSION is uses as the version string. Update the developer building from source document to reflect the changes.
2016-11-24 17:37:34 +00:00
#define KICAD_VERSION_FULL \"${KICAD_VERSION_FULL}\"
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 )
Version string improvements. Define empty string variable KICAD_BRANCH_NAME that can be used as an optional version string element. When git is used to build the version string, this variable is set to the git branch name. It can also be defined at configuration time as an optional string appended to the $KICAD_VERSION variable. Define empty string variable KICAD_VERSION_EXTRA that can be set by the user at configuration. The variables KICAD_BRANCH_NAME and KICAD_VERSION_EXTRA are only appended to KICAD_VERSION if they are set. Otherwise, only KICAD_VERSION is uses as the version string. Update the developer building from source document to reflect the changes.
2016-11-24 17:37:34 +00:00
message( STATUS "Writing ${OUTPUT_FILE} file with version: ${KICAD_VERSION_FULL}" )
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()