From 3ffd16a8a6c2f4e66448149a1bfd5d4626c8eebd Mon Sep 17 00:00:00 2001 From: Kenneth Moreland Date: Thu, 26 Jan 2017 10:02:04 -0700 Subject: [PATCH] Add ability to get VTK-m version from git In addition to keeping the version number accurate, this will help us differentiate between-the-numbers commits. --- CMake/VTKmConfig.cmake.in | 7 +- CMake/VTKmDetermineVersion.cmake | 95 +++++++++++++++ CMakeLists.txt | 20 +-- LICENSE.txt | 3 +- Utilities/Git/.gitattributes | 1 + Utilities/Git/.gitignore | 2 + Utilities/Git/Git.cmake | 31 +++++ Utilities/Git/GitInfo | 57 +++++++++ Utilities/Git/LICENSE | 202 +++++++++++++++++++++++++++++++ Utilities/Git/NOTICE | 5 + version.txt | 1 + 11 files changed, 412 insertions(+), 12 deletions(-) create mode 100644 CMake/VTKmDetermineVersion.cmake create mode 100644 Utilities/Git/.gitattributes create mode 100644 Utilities/Git/.gitignore create mode 100644 Utilities/Git/Git.cmake create mode 100644 Utilities/Git/GitInfo create mode 100644 Utilities/Git/LICENSE create mode 100644 Utilities/Git/NOTICE create mode 100644 version.txt diff --git a/CMake/VTKmConfig.cmake.in b/CMake/VTKmConfig.cmake.in index ef9f72d74..7841ab826 100755 --- a/CMake/VTKmConfig.cmake.in +++ b/CMake/VTKmConfig.cmake.in @@ -39,9 +39,10 @@ cmake_minimum_required(VERSION 3.3 FATAL_ERROR) # The VTKm version number -set(VTKm_MAJOR_VERSION "@VTKm_MAJOR_VERSION@") -set(VTKm_MINOR_VERSION "@VTKm_MINOR_VERSION@") -set(VTKm_PATCH_VERSION "@VTKm_PATCH_VERSION@") +set(VTKm_VERSION_MAJOR "@VTKm_VERSION_MAJOR@") +set(VTKm_VERSION_MINOR "@VTKm_VERSION_MINOR@") +set(VTKm_VERSION_PATCH "@VTKm_VERSION_PATCH@") +set(VTKm_VERSION_FULL "@VTKm_VERSION_FULL@") set(VTKm_VERSION "@VTKm_VERSION@") # This is true when the package is still in the build directory (not installed) diff --git a/CMake/VTKmDetermineVersion.cmake b/CMake/VTKmDetermineVersion.cmake new file mode 100644 index 000000000..fe7062288 --- /dev/null +++ b/CMake/VTKmDetermineVersion.cmake @@ -0,0 +1,95 @@ +##============================================================================ +## Copyright (c) Kitware, Inc. +## All rights reserved. +## See LICENSE.txt for details. +## This software is distributed WITHOUT ANY WARRANTY; without even +## the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR +## PURPOSE. See the above copyright notice for more information. +## +## Copyright 2017 Sandia Corporation. +## Copyright 2017 UT-Battelle, LLC. +## Copyright 2017 Los Alamos National Security. +## +## Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, +## the U.S. Government retains certain rights in this software. +## +## Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National +## Laboratory (LANL), the U.S. Government retains certain rights in +## this software. +##============================================================================ + +# Used to determine the version for VTK-m source using "git describe", if git +# is found. On success sets the following variables in caller's scope: +# ${var_prefix}_VERSION +# ${var_prefix}_VERSION_MAJOR +# ${var_prefix}_VERSION_MINOR +# ${var_prefix}_VERSION_PATCH +# ${var_prefix}_VERSION_PATCH_EXTRA +# ${var_prefix}_VERSION_FULL +# ${var_prefix}_VERSION_IS_RELEASE is true, if patch-extra is empty. +# +# If git is not found, or git describe cannot be run successfully, then these +# variables are left unchanged and a status message is printed. +# +# Arguments are: +# source_dir : Source directory +# git_command : git executable +# var_prefix : prefix for variables e.g. "VTKm". +function(determine_version source_dir git_command var_prefix) + if ("$Format:$" STREQUAL "") + # We are in an exported tarball and should use the shipped version + # information. Just return here to avoid the warning message at the end of + # this function. + return () + elseif (NOT VTKm_GIT_DESCRIBE) + if(EXISTS ${git_command}) + execute_process( + COMMAND ${git_command} describe + WORKING_DIRECTORY ${source_dir} + RESULT_VARIABLE result + OUTPUT_VARIABLE output + ERROR_QUIET + OUTPUT_STRIP_TRAILING_WHITESPACE + ERROR_STRIP_TRAILING_WHITESPACE) + endif() + else() + set(result 0) + set(output ${VTKm_GIT_DESCRIBE}) + endif() + extract_version_components("${output}" tmp) + if(DEFINED tmp_VERSION) + message(STATUS "Determined Source Version : ${tmp_VERSION_FULL}") + foreach(suffix VERSION VERSION_MAJOR VERSION_MINOR VERSION_PATCH + VERSION_PATCH_EXTRA VERSION_FULL VERSION_IS_RELEASE) + set(${var_prefix}_${suffix} ${tmp_${suffix}} PARENT_SCOPE) + endforeach() + else() + message(STATUS + "Could not use git to determine source version, using version ${${var_prefix}_VERSION_FULL}") + endif() +endfunction() + +# Extracts components from a version string. See determine_version() for usage. +function(extract_version_components version_string var_prefix) + string(REGEX MATCH "([0-9]+)\\.([0-9]+)\\.([0-9]+)[-]*(.*)" + version_matches "${version_string}") + if(CMAKE_MATCH_0) + set(full ${CMAKE_MATCH_0}) + set(major ${CMAKE_MATCH_1}) + set(minor ${CMAKE_MATCH_2}) + set(patch ${CMAKE_MATCH_3}) + set(patch_extra ${CMAKE_MATCH_4}) + + set(${var_prefix}_VERSION "${major}.${minor}" PARENT_SCOPE) + set(${var_prefix}_VERSION_MAJOR ${major} PARENT_SCOPE) + set(${var_prefix}_VERSION_MINOR ${minor} PARENT_SCOPE) + set(${var_prefix}_VERSION_PATCH ${patch} PARENT_SCOPE) + set(${var_prefix}_VERSION_PATCH_EXTRA ${patch_extra} PARENT_SCOPE) + set(${var_prefix}_VERSION_FULL ${full} PARENT_SCOPE) + if("${major}.${minor}.${patch}" VERSION_EQUAL "${full}") + set(${var_prefix}_VERSION_IS_RELEASE TRUE PARENT_SCOPE) + else() + set(${var_prefix}_VERSION_IS_RELEASE FALSE PARENT_SCOPE) + endif() + endif() +endfunction() diff --git a/CMakeLists.txt b/CMakeLists.txt index 9971ddc1d..be6fcdfa1 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -27,11 +27,6 @@ cmake_minimum_required(VERSION 3.3) project (VTKm) -set(VTKm_MAJOR_VERSION 1) -set(VTKm_MINOR_VERSION 1) -set(VTKm_PATCH_VERSION 0) -set(VTKm_VERSION "${VTKm_MAJOR_VERSION}.${VTKm_MINOR_VERSION}.${VTKm_PATCH_VERSION}") - set(VTKm_INSTALL_INCLUDE_DIR "include") set(VTKm_INSTALL_CONFIG_DIR "lib") set(VTKm_INSTALL_LIB_DIR "lib") @@ -43,6 +38,15 @@ set(VTKm_EXPORT_NAME "VTKmTargets") set(VTKm_CMAKE_MODULE_PATH ${VTKm_SOURCE_DIR}/CMake) set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${VTKm_CMAKE_MODULE_PATH}) +# Determine VTK-m version +include(Utilities/Git/Git.cmake) +include(VTKmDetermineVersion) +# Load hardcoded version in case this is not a Git repository +file(STRINGS version.txt version_txt) +extract_version_components("${version_txt}" "VTKm") +# Get the version from git if we can +determine_version(${VTKm_SOURCE_DIR} ${GIT_EXECUTABLE} "VTKm") + # include some vtkm-specific cmake code. include(VTKmMacros) @@ -314,9 +318,9 @@ install(EXPORT ${VTKm_EXPORT_NAME} set(CPACK_PACKAGE_DESCRIPTION_FILE ${VTKm_SOURCE_DIR}/README.md) set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "The VTKm Toolkit") set(CPACK_PACKAGE_NAME "VTKm") -set(CPACK_PACKAGE_VERSION_MAJOR ${VTKm_MAJOR_VERSION}) -set(CPACK_PACKAGE_VERSION_MINOR ${VTKm_MINOR_VERSION}) -set(CPACK_PACKAGE_VERSION_PATCH ${VTKm_PATCH_VERSION}) +set(CPACK_PACKAGE_VERSION_MAJOR ${VTKm_VERSION_MAJOR}) +set(CPACK_PACKAGE_VERSION_MINOR ${VTKm_VERSION_MINOR}) +set(CPACK_PACKAGE_VERSION_PATCH ${VTKm_VERSION_PATCH}) set(CPACK_PACKAGE_FILE_NAME "VTKm-${VTKm_VERSION}") set(CPACK_RESOURCE_FILE_LICENSE ${VTKm_SOURCE_DIR}/LICENSE.txt) set(CPACK_RESOURCE_FILE_README ${VTKm_SOURCE_DIR}/README.md) diff --git a/LICENSE.txt b/LICENSE.txt index b99194922..feafb91e8 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -72,6 +72,7 @@ licenses. - - - - - - - - - - - - - - - - - - - - - - - - do not remove this line CMake/FindTBB.cmake CMake/FindGLEW.cmake +Utilities vtkm/cont/tbb/internal/parallel_sort.h vtkm/testing/OptionParser.h -vtkm/internal/brigand.hpp \ No newline at end of file +vtkm/internal/brigand.hpp diff --git a/Utilities/Git/.gitattributes b/Utilities/Git/.gitattributes new file mode 100644 index 000000000..48735ba94 --- /dev/null +++ b/Utilities/Git/.gitattributes @@ -0,0 +1 @@ +GitInfo crlf=input diff --git a/Utilities/Git/.gitignore b/Utilities/Git/.gitignore new file mode 100644 index 000000000..a8ce67fcb --- /dev/null +++ b/Utilities/Git/.gitignore @@ -0,0 +1,2 @@ +# Generated in source tree by GitInfo script +GitInfo.cmake diff --git a/Utilities/Git/Git.cmake b/Utilities/Git/Git.cmake new file mode 100644 index 000000000..4142fff5a --- /dev/null +++ b/Utilities/Git/Git.cmake @@ -0,0 +1,31 @@ +#============================================================================= +# Copyright 2011 Kitware, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#============================================================================= + +# Check for a hint left by the 'GitInfo' script. +if(NOT GIT_EXECUTABLE) + get_filename_component(_Git_DIR ${CMAKE_CURRENT_LIST_FILE} PATH) + include(${_Git_DIR}/GitInfo.cmake OPTIONAL) + if(GitInfo_GIT_EXECUTABLE) + if(EXISTS "${GitInfo_GIT_EXECUTABLE}") + set(GIT_EXECUTABLE "${GitInfo_GIT_EXECUTABLE}") + elseif(EXISTS "${GitInfo_GIT_EXECUTABLE}.exe") + set(GIT_EXECUTABLE "${GitInfo_GIT_EXECUTABLE}.exe") + endif() + endif() +endif() + +# Find Git. +find_package(Git) diff --git a/Utilities/Git/GitInfo b/Utilities/Git/GitInfo new file mode 100644 index 000000000..9e51b39c4 --- /dev/null +++ b/Utilities/Git/GitInfo @@ -0,0 +1,57 @@ +#!/usr/bin/env bash +#============================================================================= +# Copyright 2011 Kitware, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#============================================================================= + +# Path conversion function. +case "$(uname)" in + *CYGWIN*) + native_path() { + cygpath -m "$1" + } + ;; + *MINGW*) + native_path() { + cmd //c echo "$1" | sed 's/^"//;s/"$//' + } + ;; + *) + native_path() { + echo "$1" + } + ;; +esac + +# Compute native path to "git" executable. +if git="$(type -p git)"; then + git="$(native_path "${git}")" +else + git='' +fi + +# Compute native path to ".git" dir. +if dir="$(git rev-parse --git-dir)"; then + dir="$(cd "$dir"; pwd)" + git_dir="$(native_path "${dir}")" +else + git_dir='' +fi + +# Store the values in a CMake file next to this script. +echo >"${BASH_SOURCE%/*}/GitInfo.cmake" '# Generated by GitInfo +set(GitInfo 1) +set(GitInfo_GIT_EXECUTABLE "'"$git"'") +set(GitInfo_GIT_DIR "'"$git_dir"'") +' diff --git a/Utilities/Git/LICENSE b/Utilities/Git/LICENSE new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/Utilities/Git/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Utilities/Git/NOTICE b/Utilities/Git/NOTICE new file mode 100644 index 000000000..8f2a7bce8 --- /dev/null +++ b/Utilities/Git/NOTICE @@ -0,0 +1,5 @@ +Git Support Scripts +Copyright 2011 Kitware, Inc. + +This product includes software developed at Kitware, Inc. +(http://www.kitware.com/). diff --git a/version.txt b/version.txt new file mode 100644 index 000000000..77d6f4ca2 --- /dev/null +++ b/version.txt @@ -0,0 +1 @@ +0.0.0