diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index be6b93fc..7d4f1a19 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -11,7 +11,7 @@ jobs: uses: actions/checkout@v2 - name: Compile and test id: ci - uses: ignition-tooling/action-ignition-ci@focal + uses: gazebo-tooling/action-gz-ci@focal with: cmake-args: '-DBUILDSYSTEM_TESTING=True' jammy-ci: @@ -22,7 +22,6 @@ jobs: uses: actions/checkout@v2 - name: Compile and test id: ci - uses: ignition-tooling/action-ignition-ci@jammy + uses: gazebo-tooling/action-gz-ci@jammy with: cmake-args: '-DBUILDSYSTEM_TESTING=True' - diff --git a/.github/workflows/pr-collection-labeler.yml b/.github/workflows/pr-collection-labeler.yml index 7d7b4e17..38c4fc13 100644 --- a/.github/workflows/pr-collection-labeler.yml +++ b/.github/workflows/pr-collection-labeler.yml @@ -8,6 +8,6 @@ jobs: steps: - name: Add collection labels if: github.event.action == 'opened' - uses: ignition-tooling/pr-collection-labeler@v1 + uses: gazebo-tooling/pr-collection-labeler@v1 with: github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/CMakeLists.txt b/CMakeLists.txt index 38b6559c..5a4f3abc 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -6,16 +6,16 @@ cmake_minimum_required(VERSION 3.10.2 FATAL_ERROR) project(gz-cmake3 VERSION 3.0.0) #-------------------------------------- -# Initialize the IGNITION_CMAKE_DIR variable with the location of the cmake +# Initialize the GZ_CMAKE_DIR variable with the location of the cmake # directory that sits next to this find-module. -set(IGNITION_CMAKE_DIR "${CMAKE_CURRENT_LIST_DIR}/cmake") +set(GZ_CMAKE_DIR "${CMAKE_CURRENT_LIST_DIR}/cmake") #-------------------------------------- # Add the location of this package's cmake directory to the CMAKE_MODULE_PATH -list(APPEND CMAKE_MODULE_PATH "${IGNITION_CMAKE_DIR}") +list(APPEND CMAKE_MODULE_PATH "${GZ_CMAKE_DIR}") #-------------------------------------- -# include the master IgnCMake module +# include the master GzCMake module include(GzCMake) #-------------------------------------- @@ -27,26 +27,26 @@ gz_configure_project(VERSION_SUFFIX pre1) option(BUILDSYSTEM_TESTING "Enable extended buildsystem testing" FALSE) #-------------------------------------- -# Install the ignition documentation files +# Install the Gazebo documentation files # Note: This is not actually creating a doc target for gz-cmake; this is just # installing files that are useful for generating the documentation of other -# ignition projects. +# Gazebo projects. add_subdirectory(doc) #-------------------------------------- # Install the benchmark files install(DIRECTORY benchmark/ - DESTINATION ${IGN_DATA_INSTALL_DIR}/benchmark) + DESTINATION ${GZ_DATA_INSTALL_DIR}/benchmark) #-------------------------------------- # Install the codecheck files install(DIRECTORY codecheck/ - DESTINATION ${IGN_DATA_INSTALL_DIR}/codecheck) + DESTINATION ${GZ_DATA_INSTALL_DIR}/codecheck) #-------------------------------------- # Install the tools files install(DIRECTORY tools/ - DESTINATION ${IGN_DATA_INSTALL_DIR}/tools) + DESTINATION ${GZ_DATA_INSTALL_DIR}/tools) #============================================================================ # Configure the package to be installed @@ -58,12 +58,12 @@ set(gz_config_input "${CMAKE_CURRENT_SOURCE_DIR}/config/gz-cmake-config.cmake.i set(gz_config_output "${PROJECT_NAME_LOWER}-config.cmake") set(gz_version_output "${PROJECT_NAME_LOWER}-config-version.cmake") set(gz_config_install_dir "${CMAKE_INSTALL_DATAROOTDIR}/cmake/${PROJECT_NAME_LOWER}") -set(ign_pkgconfig_input "${CMAKE_CURRENT_SOURCE_DIR}/config/gz-cmake.pc.in") -set(ign_pkgconfig_output "${CMAKE_BINARY_DIR}/${PROJECT_NAME}.pc") -set(ign_pkgconfig_install_dir "${IGN_LIB_INSTALL_DIR}/pkgconfig") -set(ign_utilities_target ${PROJECT_EXPORT_NAME}-utilities) -set(ign_utilities_import_target_name ${PROJECT_EXPORT_NAME}::${ign_utilities_target}) -set(ign_utilities_target_output_filename "${ign_utilities_target}-targets.cmake") +set(gz_pkgconfig_input "${CMAKE_CURRENT_SOURCE_DIR}/config/gz-cmake.pc.in") +set(gz_pkgconfig_output "${CMAKE_BINARY_DIR}/${PROJECT_NAME}.pc") +set(gz_pkgconfig_install_dir "${GZ_LIB_INSTALL_DIR}/pkgconfig") +set(gz_utilities_target ${PROJECT_EXPORT_NAME}-utilities) +set(gz_utilities_import_target_name ${PROJECT_EXPORT_NAME}::${gz_utilities_target}) +set(gz_utilities_target_output_filename "${gz_utilities_target}-targets.cmake") set(simple_utilities_import_name ${PROJECT_EXPORT_NAME}::utilities) #-------------------------------------- @@ -72,7 +72,7 @@ configure_package_config_file( ${gz_config_input} ${gz_config_output} INSTALL_DESTINATION ${gz_config_install_dir} - PATH_VARS IGN_DATA_INSTALL_DIR + PATH_VARS GZ_DATA_INSTALL_DIR NO_CHECK_REQUIRED_COMPONENTS_MACRO) #-------------------------------------- @@ -92,50 +92,50 @@ install( #-------------------------------------- # Configure and install the pkgconfig file (needed for utilities headers) file(RELATIVE_PATH - IGN_PC_CONFIG_RELATIVE_PATH_TO_PREFIX - "${CMAKE_INSTALL_PREFIX}/${ign_pkgconfig_install_dir}" + GZ_PC_CONFIG_RELATIVE_PATH_TO_PREFIX + "${CMAKE_INSTALL_PREFIX}/${gz_pkgconfig_install_dir}" "${CMAKE_INSTALL_PREFIX}" ) -configure_file(${ign_pkgconfig_input} ${ign_pkgconfig_output} @ONLY) +configure_file(${gz_pkgconfig_input} ${gz_pkgconfig_output} @ONLY) install( - FILES ${ign_pkgconfig_output} - DESTINATION ${ign_pkgconfig_install_dir} + FILES ${gz_pkgconfig_output} + DESTINATION ${gz_pkgconfig_install_dir} COMPONENT pkgconfig) #============================================================================ # Create and install the utilities component #============================================================================ # Deprecated: Remove the utilities component in gz-cmake4 -add_library(${ign_utilities_target} INTERFACE) -target_include_directories(${ign_utilities_target} +add_library(${gz_utilities_target} INTERFACE) +target_include_directories(${gz_utilities_target} INTERFACE - $ + $ $ $) # Export and install the interface target install( - TARGETS ${ign_utilities_target} - EXPORT ${ign_utilities_target} + TARGETS ${gz_utilities_target} + EXPORT ${gz_utilities_target} COMPONENT interface) export( - EXPORT ${ign_utilities_target} - FILE ${ign_utilities_target_output_filename} + EXPORT ${gz_utilities_target} + FILE ${gz_utilities_target_output_filename} NAMESPACE ${PROJECT_EXPORT_NAME}::) install( - EXPORT ${ign_utilities_target} + EXPORT ${gz_utilities_target} DESTINATION ${gz_config_install_dir} - FILE ${ign_utilities_target_output_filename} + FILE ${gz_utilities_target_output_filename} NAMESPACE ${PROJECT_EXPORT_NAME}::) # Install the header directory # Note: The trailing slash after "include" is necessary install( DIRECTORY include/ - DESTINATION ${IGN_INCLUDE_INSTALL_DIR_FULL} + DESTINATION ${GZ_INCLUDE_INSTALL_DIR_FULL} COMPONENT headers) #============================================================================ @@ -230,12 +230,14 @@ set(CPPCHECK_INCLUDE_DIRS ${CMAKE_SOURCE_DIR}/include ${CMAKE_SOURCE_DIR}/examples ) -set(IGNITION_CMAKE_CODECHECK_DIR "${CMAKE_CURRENT_SOURCE_DIR}/codecheck") +set(GZ_CMAKE_CODECHECK_DIR "${CMAKE_CURRENT_SOURCE_DIR}/codecheck") include(GzCodeCheck) _gz_setup_target_for_codecheck() # Docs -set(IGNITION_CMAKE_DOXYGEN_DIR "${CMAKE_CURRENT_SOURCE_DIR}/doc/doxygen") +set(GZ_CMAKE_DOXYGEN_DIR "${CMAKE_CURRENT_SOURCE_DIR}/doc/doxygen") +set(IGNITION_CMAKE_DOXYGEN_DIR ${GZ_CMAKE_DOXYGEN_DIR}) # TODO(CH3): Deprecated. Remove on tock. + configure_file(${CMAKE_SOURCE_DIR}/api.md.in ${CMAKE_BINARY_DIR}/api.md) configure_file(${CMAKE_SOURCE_DIR}/tutorials.md.in ${CMAKE_BINARY_DIR}/tutorials.md) gz_create_docs( diff --git a/Changelog.md b/Changelog.md index d5c378ff..3e407e71 100644 --- a/Changelog.md +++ b/Changelog.md @@ -2,7 +2,7 @@ ### Gazebo CMake 2.12.1 (2022-04-12) -1. Allow to recreate targets created by IgnPkgConfig +1. Allow to recreate targets created by GzPkgConfig * [Pull request #231](https://github.com/gazebosim/gz-cmake/pull/231) 1. Adding tests for CONFIG argument @@ -13,7 +13,7 @@ 1. Adding CONFIG option * [Pull request #211](https://github.com/gazebosim/gz-cmake/pull/211) -1. IgnFindOGRE2: support for the ogre-next package on Ubuntu Jammy +1. GzFindOGRE2: support for the ogre-next package on Ubuntu Jammy * [Pull request #224](https://github.com/gazebosim/gz-cmake/pull/224) 1. Fix check for missing components in OGRE2. Be more verbose with components @@ -23,7 +23,7 @@ * [Pull request #219](https://github.com/gazebosim/gz-cmake/pull/219) * [Pull request #221](https://github.com/gazebosim/gz-cmake/pull/221) -1. Specify sanitizers using IGN_SANITIZERS cmake variable +1. Specify sanitizers using GZ_SANITIZERS cmake variable * [Pull request #210](https://github.com/gazebosim/gz-cmake/pull/210) 1. Replace deprecated PythonInterp with Python3 (#213) @@ -58,10 +58,10 @@ 1. Do not modify `CMAKE_FIND_LIBRARY_PREFIXES` and `CMAKE_FIND_LIBRARY_SUFFIXES` on Windows * [Pull request #189](https://github.com/gazebosim/gz-cmake/pull/189) -1. Project option: `REPLACE_IGNITION_INCLUDE_PATH` +1. Project option: `REPLACE_INCLUDE_PATH` * [Pull request #190](https://github.com/gazebosim/gz-cmake/pull/190) -1. Project option: `NO_IGNITION_PREFIX` +1. Project option: `NO_PROJECT_PREFIX` * [Pull request #191](https://github.com/gazebosim/gz-cmake/pull/191) ### Gazebo CMake 2.9.0 (2021-09-02) @@ -69,13 +69,13 @@ 1. Fix include directory flags for codecheck * [Pull request #186](https://github.com/gazebosim/gz-cmake/pull/186) -1. Fix problems on IgnOGRE when version is not found +1. Fix problems on GzOGRE when version is not found * [Pull request #175](https://github.com/gazebosim/gz-cmake/pull/175) 1. Remove bitbucket-pipelines.yml * [Pull request #181](https://github.com/gazebosim/gz-cmake/pull/181) -1. Include IMAGE_PATH directories in ign_create_docs +1. Include IMAGE_PATH directories in gz_create_docs * [Pull request #183](https://github.com/gazebosim/gz-cmake/pull/183) 1. Special case for ogre2.2 on Windows @@ -195,7 +195,7 @@ ### Gazebo CMake 2.4.0 (2020-08-20) -1. Added an option to include generated code in the ign_create_docs function +1. Added an option to include generated code in the gz_create_docs function * [Pull request 108](https://github.com/gazebosim/gz-cmake/pull/108) ### Gazebo CMake 2.3.0 (2020-08-07) @@ -258,7 +258,7 @@ * [BitBucket pull request 161](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-cmake/pull-requests/161) * [BitBucket pull request 155](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-cmake/pull-requests/155) -1. IgnConfigureBuild: only `add_subdirectory(test)` if `BUILD_TESTING` is ON +1. GzConfigureBuild: only `add_subdirectory(test)` if `BUILD_TESTING` is ON * [BitBucket pull request 169](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-cmake/pull-requests/169) 1. Add FindGzBullet cmake module. @@ -315,7 +315,7 @@ * [BitBucket pull request 171](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-cmake/pull-requests/171) * [BitBucket pull request 168](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-cmake/pull-requests/168) -1. IgnConfigureBuild: only `add_subdirectory(test)` if `BUILD_TESTING` is ON +1. GzConfigureBuild: only `add_subdirectory(test)` if `BUILD_TESTING` is ON * [BitBucket pull request 165](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-cmake/pull-requests/165) 1. Fix race condition in test for issue 48 @@ -345,10 +345,10 @@ 1. Avoid hardcoding /machine:x64 flag on 64-bit on MSVC. * [BitBucket pull request 168](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-cmake/pull-requests/168) -1. IgnConfigureBuild: only `add_subdirectory(test)` if `BUILD_TESTING` is ON +1. GzConfigureBuild: only `add_subdirectory(test)` if `BUILD_TESTING` is ON * [BitBucket pull request 163](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-cmake/pull-requests/163) -1. IgnConfigureProject.cmake: fix small typo PKCONFIG -> PKGCONFIG +1. GzConfigureProject.cmake: fix small typo PKCONFIG -> PKGCONFIG * [BitBucket pull request 118](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-cmake/pull-requests/118) ### Gazebo CMake 0.6.1 diff --git a/Migration.md b/Migration.md index d89644be..77f2c93e 100644 --- a/Migration.md +++ b/Migration.md @@ -15,7 +15,10 @@ release will remove the deprecated code. **Replacement**: CMake functions and macros starting with `gz_` 1. **Deprecated**: `ignition` namespaces **Replacement**: `gz` namespaces - +1. **Deprecated**: `Ign` prefixed CMake files + **Replacement**: `Gz` prefixed CMake files +1. **Deprecated**: `IGN/IGNITION` prefixed CMake variables and options + **Replacement**: `GZ` prefixed CMake variables and options 1. **Breaking**: The project name has been changed to use the `gz-` prefix, you **must** use the `gz` prefix! * This also means that any generated code that use the project name (e.g. CMake variables, in-source macros) would have to be migrated. * Some non-exhaustive examples of this include: diff --git a/MigrationFromClassic.md b/MigrationFromClassic.md index ce63e385..1cba8afd 100644 --- a/MigrationFromClassic.md +++ b/MigrationFromClassic.md @@ -56,7 +56,7 @@ A variety of arguments are available to guide the behavior of `gz_find_package(~)`. Most of them will not be needed in most situations, but you should consider reading them over once just in case they might be relevant for you. The macro's documentation is available in -`gz-cmake/cmake/IgnUtils.cmake` just above definition of `gz_find_package(~)`. +`gz-cmake/cmake/GzUtils.cmake` just above definition of `gz_find_package(~)`. Feel free to ask questions about any of its arguments that are unclear. Any operations that might need to be performed while searching for a package @@ -88,7 +88,7 @@ and adopting their convention will reduce the friction that we experience when interfacing with a wide variety of native CMake utilities. It's also beneficial to embrace the "single source of truth" pattern. -### Change instances of `IGN_PROJECT_NAME` to `IGN_DESIGNATION` +### Change instances of `IGN_PROJECT_NAME` to `GZ_DESIGNATION` We've had a variable called `IGN_PROJECT_NAME` which refers to the `` in the `gz-` name of each project. I felt that the name of the @@ -97,7 +97,7 @@ defined by CMake, as well as the `PROJECT_NAME[_NO_VERSION][_UPPER/_LOWER]` that we define for convenience. Instead of referring to both as `[IGN_]PROJECT_NAME`, I thought it would be better to use clear and distinct words to distinguish them. Therefore the `` part of the project name is now referred to as -`IGN_DESIGNATION`, and we provide `IGN_DESIGNATION[_LOWER/_UPPER]` for +`GZ_DESIGNATION`, and we provide `GZ_DESIGNATION[_LOWER/_UPPER]` for convenience. ### Do not use `append_to_cached_string` or `append_to_cached_list` anymore. @@ -122,7 +122,7 @@ requires a certain standard, it MUST be specified directly to this function in order to ensure that the requirement gets correctly propagated into the project's package information so that dependent libraries will also be aware of the requirement. See the documentation of `gz_create_core_library(~)` in -`gz-cmake/cmake/IgnUtils.cmake` for more details on how to specify your +`gz-cmake/cmake/GzUtils.cmake` for more details on how to specify your library's C++ standard requirement. ### Specify `TYPE` and `SOURCES` arguments in `gz_build_tests(~)` diff --git a/README.md b/README.md index d8f4d70d..cf0b778c 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ The [Source Install](#source-install) instructions should be used if you need th On Ubuntu systems, `apt-get` can be used to install `gz-cmake`: ``` -$ sudo apt install libignition-cmake<#>-dev +$ sudo apt install libgz-cmake<#>-dev ``` Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on which version you need. diff --git a/api.md.in b/api.md.in index 076d0382..50360ff6 100644 --- a/api.md.in +++ b/api.md.in @@ -1,6 +1,6 @@ -## Gazebo @IGN_DESIGNATION_CAP@ +## Gazebo @GZ_DESIGNATION_CAP@ -Gazebo @IGN_DESIGNATION_CAP@ is a component in Gazebo, a set of libraries +Gazebo @GZ_DESIGNATION_CAP@ is a component in Gazebo, a set of libraries designed to rapidly develop robot and simulation applications. ## License diff --git a/benchmark/run_benchmarks.py b/benchmark/run_benchmarks.py index 16bbe1a1..b143581d 100755 --- a/benchmark/run_benchmarks.py +++ b/benchmark/run_benchmarks.py @@ -90,7 +90,7 @@ def collect_results(project_name, results_dir): if __name__ == '__main__': parser = argparse.ArgumentParser('Run and aggregate available benchmarks') - parser.add_argument('--project-name', help='Name of the Ignition project') + parser.add_argument('--project-name', help='Name of the Gazebo project') parser.add_argument('--version-file', help='Generated file containing version information') parser.add_argument('--benchmark-targets', help='Targets to be executed') diff --git a/cmake/FindGzProtobuf.cmake b/cmake/FindGzProtobuf.cmake index 6b183830..4209f2eb 100644 --- a/cmake/FindGzProtobuf.cmake +++ b/cmake/FindGzProtobuf.cmake @@ -16,7 +16,7 @@ ######################################## # Find Protobuf -# This is an ignition wrapper for finding Protobuf. The purpose of this find +# This is a Gazebo wrapper for finding Protobuf. The purpose of this find # module is to search for a config-file for Protobuf before resorting to using # the native CMake find-module for Protobuf. This ensures that if a specially # configured version of Protobuf is installed, then its exported targets will be diff --git a/cmake/GzBenchmark.cmake b/cmake/GzBenchmark.cmake index 0437adcc..2a611291 100644 --- a/cmake/GzBenchmark.cmake +++ b/cmake/GzBenchmark.cmake @@ -43,7 +43,7 @@ function(_gz_add_version_info_target) # that forces the file to be regenerated at build time. add_custom_target(version_info_target COMMAND ${CMAKE_COMMAND} - -Dinput_file=${IGNITION_CMAKE_DIR}/version_info.json.in + -Dinput_file=${GZ_CMAKE_DIR}/version_info.json.in -Doutput_file=${CMAKE_CURRENT_BINARY_DIR}/version_info.json -Drepository_root=${CMAKE_CURRENT_SOURCE_DIR} # Yes, these variables need to be passed in, because they won't @@ -55,7 +55,7 @@ function(_gz_add_version_info_target) -DPROJECT_VERSION_MINOR=${PROJECT_VERSION_MINOR} -DPROJECT_VERSION_PATCH=${PROJECT_VERSION_PATCH} -DPROJECT_NAME=${PROJECT_NAME} - -P ${IGNITION_CMAKE_DIR}/IgnGenerateVersionInfo.cmake + -P ${GZ_CMAKE_DIR}/GzGenerateVersionInfo.cmake ) endfunction() @@ -107,7 +107,7 @@ function(gz_add_benchmarks) add_custom_target( run_benchmarks - COMMAND python3 ${IGNITION_CMAKE_BENCHMARK_DIR}/run_benchmarks.py + COMMAND python3 ${GZ_CMAKE_BENCHMARK_DIR}/run_benchmarks.py --project-name ${PROJECT_NAME} --version-file ${CMAKE_CURRENT_BINARY_DIR}/version_info.json --benchmark-targets ${CMAKE_CURRENT_BINARY_DIR}/benchmark_targets diff --git a/cmake/GzCMake.cmake b/cmake/GzCMake.cmake index 171ec0bb..1ad8506e 100644 --- a/cmake/GzCMake.cmake +++ b/cmake/GzCMake.cmake @@ -2,7 +2,7 @@ # GzCMake # -------- # -# Includes a set of modules that are needed for building the ignition libraries +# Includes a set of modules that are needed for building the Gazebo libraries # #=============================================================================== # Copyright (C) 2017 Open Source Robotics Foundation diff --git a/cmake/GzCheckSSE.cmake b/cmake/GzCheckSSE.cmake index dc5b498e..81dd3066 100644 --- a/cmake/GzCheckSSE.cmake +++ b/cmake/GzCheckSSE.cmake @@ -20,7 +20,7 @@ # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -# Modified for ignition libraries - 2017 +# Modified for Gazebo libraries - 2017 # Based on the Qt 5 processor detection code, so should be very accurate # https://qt.gitorious.org/qt/qtbase/blobs/master/src/corelib/global/qprocessordetection.h diff --git a/cmake/GzCodeCheck.cmake b/cmake/GzCodeCheck.cmake index 8e2878c1..0cb43aa4 100644 --- a/cmake/GzCodeCheck.cmake +++ b/cmake/GzCodeCheck.cmake @@ -26,7 +26,7 @@ function(_gz_setup_target_for_codecheck) set (CPPCHECK_EXTRA --enable=style,performance,portability,information) # Rules for cppcheck - set (CPPCHECK_RULES "-UM_PI --rule-file=${IGNITION_CMAKE_CODECHECK_DIR}/header_guard.rule --rule-file=${IGNITION_CMAKE_CODECHECK_DIR}/namespace_AZ.rule") + set (CPPCHECK_RULES "-UM_PI --rule-file=${GZ_CMAKE_CODECHECK_DIR}/header_guard.rule --rule-file=${GZ_CMAKE_CODECHECK_DIR}/namespace_AZ.rule") # The find command set (CPPCHECK_FIND ${FIND_PATH} ${CPPCHECK_DIRS} -name '*.cc' -o -name '*.hh' -o -name '*.c' -o -name '*.h') @@ -53,7 +53,7 @@ function(_gz_setup_target_for_codecheck) if(Python3_Interpreter_FOUND) add_custom_target(cpplint - COMMAND ${Python3_EXECUTABLE} ${IGNITION_CMAKE_CODECHECK_DIR}/cpplint.py --extensions=cc,hh --quiet `${CPPCHECK_FIND}` + COMMAND ${Python3_EXECUTABLE} ${GZ_CMAKE_CODECHECK_DIR}/cpplint.py --extensions=cc,hh --quiet `${CPPCHECK_FIND}` ) add_dependencies(codecheck cpplint) diff --git a/cmake/GzCodeCoverage.cmake b/cmake/GzCodeCoverage.cmake index 2174455c..fa7754d6 100644 --- a/cmake/GzCodeCoverage.cmake +++ b/cmake/GzCodeCoverage.cmake @@ -7,7 +7,7 @@ # - Some additional usage instructions. # # 2017-09-13 -# - Tweaked instructions for ignition libraries +# - Tweaked instructions for Gazebo libraries # - Tweaked function name to avoid name collisions # # USAGE: @@ -18,10 +18,10 @@ # SET(CMAKE_CXX_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage") # SET(CMAKE_C_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage") # -# 3. Use the function IGN_SETUP_TARGET_FOR_COVERAGE to create a custom make target +# 3. Use the function GZ_SETUP_TARGET_FOR_COVERAGE to create a custom make target # which runs your test executable and produces a lcov code coverage report: # Example: -# IGN_SETUP_TARGET_FOR_COVERAGE( +# GZ_SETUP_TARGET_FOR_COVERAGE( # my_coverage_target # Name for custom target. # test_driver # Name of the test driver executable that runs the tests. # # NOTE! This should always have a ZERO as exit code @@ -62,7 +62,7 @@ ENDIF() # NOT CMAKE_BUILD_TYPE STREQUAL "Debug" ################################################# -# ign_setup_target_for_coverage( +# gz_setup_target_for_coverage( # [BRANCH_COVERAGE] # [OUTPUT_NAME ] # [TARGET_NAME ] @@ -88,7 +88,7 @@ ENDIF() # NOT CMAKE_BUILD_TYPE STREQUAL "Debug" # MUST return ZERO always, even on errors. # If not, no coverage report will be created! # -FUNCTION(ign_setup_target_for_coverage) +FUNCTION(gz_setup_target_for_coverage) #------------------------------------ # Define the expected arguments @@ -153,4 +153,4 @@ FUNCTION(ign_setup_target_for_coverage) COMMENT "Open ./${_outputname}/index.html in your browser to view the coverage report." ) -ENDFUNCTION() # IGN_SETUP_TARGET_FOR_COVERAGE +ENDFUNCTION() # GZ_SETUP_TARGET_FOR_COVERAGE diff --git a/cmake/GzConfigureBuild.cmake b/cmake/GzConfigureBuild.cmake index 85c79aa9..1185e832 100644 --- a/cmake/GzConfigureBuild.cmake +++ b/cmake/GzConfigureBuild.cmake @@ -22,7 +22,7 @@ # limitations under the License. ################################################# -# Configure the build of the ignition project +# Configure the build of the Gazebo project # Pass the argument HIDE_SYMBOLS_BY_DEFAULT to configure symbol visibility so # that symbols are hidden unless explicitly marked as visible. # Pass the argument QUIT_IF_BUILD_ERRORS to have this macro quit cmake when the @@ -164,7 +164,7 @@ macro(gz_configure_build) #-------------------------------------- # Add the source, include, and test directories to the cppcheck dirs. - # CPPCHECK_DIRS is used in IgnCodeCheck. The variable specifies the + # CPPCHECK_DIRS is used in GzCodeCheck. The variable specifies the # directories static code analyzers should check. Additional directories # are added for each component. set (CPPCHECK_DIRS) @@ -302,11 +302,15 @@ endmacro() macro(_gz_set_cxx_feature_flags) - set(IGN_KNOWN_CXX_STANDARDS 11 14 17) + set(GZ_KNOWN_CXX_STANDARDS 11 14 17) + set(GZ_CXX_11_FEATURES cxx_std_11) + set(GZ_CXX_14_FEATURES cxx_std_14) + set(GZ_CXX_17_FEATURES cxx_std_17) - set(IGN_CXX_11_FEATURES cxx_std_11) - set(IGN_CXX_14_FEATURES cxx_std_14) - set(IGN_CXX_17_FEATURES cxx_std_17) + set(IGN_KNOWN_CXX_STANDARDS ${GZ_KNOWN_CXX_STANDARDS}) # TODO(CH3): IGN_KNOWN_CXX_STANDARDS IS DEPRECATED. + set(IGN_CXX_11_FEATURES ${GZ_CXX_11_FEATURES}) # TODO(CH3): IGN_CXX_11_FEATURES IS DEPRECATED. + set(IGN_CXX_14_FEATURES ${GZ_CXX_14_FEATURES}) # TODO(CH3): IGN_CXX_14_FEATURES IS DEPRECATED. + set(IGN_CXX_17_FEATURES ${GZ_CXX_17_FEATURES}) # TODO(CH3): IGN_CXX_17_FEATURES IS DEPRECATED. endmacro() @@ -337,7 +341,9 @@ function(_gz_find_include_script) if(EXISTS "${include_start}/include") if(EXISTS "${include_start}/include/CMakeLists.txt") add_subdirectory("${include_start}/include") - elseif(EXISTS "${include_start}/include/ignition/CMakeLists.txt") + elseif(EXISTS "${include_start}/include/gz/CMakeLists.txt") + add_subdirectory("${include_start}/include/gz") + elseif(EXISTS "${include_start}/include/ignition/CMakeLists.txt") # TODO(CH3): Deprecated. Remove on tock. add_subdirectory("${include_start}/include/ignition") elseif(EXISTS "${include_start}/include/${PROJECT_INCLUDE_DIR}/CMakeLists.txt") add_subdirectory("${include_start}/include/${PROJECT_INCLUDE_DIR}") @@ -388,11 +394,11 @@ macro(_gz_parse_build_type) elseif("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "COVERAGE") include(GzCodeCoverage) set(BUILD_TYPE_DEBUG TRUE) - ign_setup_target_for_coverage( + gz_setup_target_for_coverage( OUTPUT_NAME coverage TARGET_NAME coverage TEST_RUNNER ctest) - ign_setup_target_for_coverage( + gz_setup_target_for_coverage( BRANCH_COVERAGE OUTPUT_NAME coverage-branch TARGET_NAME coverage-branch diff --git a/cmake/GzConfigureProject.cmake b/cmake/GzConfigureProject.cmake index f8ba1247..13c06ed0 100644 --- a/cmake/GzConfigureProject.cmake +++ b/cmake/GzConfigureProject.cmake @@ -6,11 +6,11 @@ # # Sets up a Gazebo library project. # -# NO_IGNITION_PREFIX: Optional. Don't use ignition as prefix in +# NO_PROJECT_PREFIX: Optional. Don't use gz- as prefix in # cmake project name. -# REPLACE_IGNITION_INCLUDE_PATH: Optional. Specify include folder +# REPLACE_INCLUDE_PATH: Optional. Specify include folder # names to replace the default value of -# ignition/${IGN_DESIGNATION} +# gz/${GZ_DESIGNATION} # VERSION_SUFFIX: Optional. Specify a prerelease version suffix. # #=============================================================================== @@ -29,13 +29,13 @@ # limitations under the License. ################################################# -# Initialize the ignition project +# Initialize the Gazebo project macro(ign_configure_project) # TODO(chapulina) Enable warnings after all libraries have migrated. # message(WARNING "ign_configure_project is deprecated, use gz_configure_project instead.") - set(options NO_IGNITION_PREFIX) - set(oneValueArgs REPLACE_IGNITION_INCLUDE_PATH VERSION_SUFFIX) + set(options NO_PROJECT_PREFIX NO_IGNITION_PREFIX) # TODO(CH3): NO_IGNITION_PREFIX IS DEPRECATED. + set(oneValueArgs REPLACE_INCLUDE_PATH REPLACE_IGNITION_INCLUDE_PATH VERSION_SUFFIX) # TODO(CH3): REPLACE_IGNITION_INCLUDE_PATH IS DEPRECATED. set(multiValueArgs) # We are not using multiValueArgs yet _gz_cmake_parse_arguments(gz_configure_project "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) @@ -48,8 +48,8 @@ macro(gz_configure_project) if (NOT gz_configure_project_skip_parsing) #------------------------------------ # Define the expected arguments - set(options NO_IGNITION_PREFIX) - set(oneValueArgs REPLACE_IGNITION_INCLUDE_PATH VERSION_SUFFIX) + set(options NO_PROJECT_PREFIX NO_IGNITION_PREFIX) # TODO(CH3): NO_IGNITION_PREFIX IS DEPRECATED. + set(oneValueArgs REPLACE_INCLUDE_PATH REPLACE_IGNITION_INCLUDE_PATH VERSION_SUFFIX) # TODO(CH3): REPLACE_IGNITION_INCLUDE_PATH IS DEPRECATED. set(multiValueArgs) # We are not using multiValueArgs yet #------------------------------------ @@ -70,47 +70,59 @@ macro(gz_configure_project) #============================================================================ # Extract the designation #============================================================================ - set(IGN_DESIGNATION ${PROJECT_NAME}) + set(GZ_DESIGNATION ${PROJECT_NAME}) # Remove the leading project prefix ("gz-" by default) set(PROJECT_PREFIX "gz") # Also support "ignition-" # TODO: remove this `if` block once all package names start with gz - if(${IGN_DESIGNATION} MATCHES "^ignition-") + if(${GZ_DESIGNATION} MATCHES "^ignition-") set(PROJECT_PREFIX "ignition") endif() - string(REGEX REPLACE "${PROJECT_PREFIX}-" "" IGN_DESIGNATION ${IGN_DESIGNATION}) + string(REGEX REPLACE "${PROJECT_PREFIX}-" "" GZ_DESIGNATION ${GZ_DESIGNATION}) # Remove the trailing version number - string(REGEX REPLACE "[0-9]+" "" IGN_DESIGNATION ${IGN_DESIGNATION}) + string(REGEX REPLACE "[0-9]+" "" GZ_DESIGNATION ${GZ_DESIGNATION}) #============================================================================ # Set project variables #============================================================================ - if(gz_configure_project_NO_IGNITION_PREFIX) - set(PROJECT_NAME_NO_VERSION ${IGN_DESIGNATION}) + if(gz_configure_project_NO_PROJECT_PREFIX) + set(PROJECT_NAME_NO_VERSION ${GZ_DESIGNATION}) + elseif(gz_configure_project_NO_IGNITION_PREFIX) # TODO(CH3): NO_IGNITION_PREFIX IS DEPRECATED. + message(DEPRECATION "[NO_IGNITION_PREFIX] is deprecated. Please use [NO_PROJECT_PREFIX] instead!") + set(PROJECT_NAME_NO_VERSION ${GZ_DESIGNATION}) else() - set(PROJECT_NAME_NO_VERSION "${PROJECT_PREFIX}-${IGN_DESIGNATION}") + set(PROJECT_NAME_NO_VERSION "${PROJECT_PREFIX}-${GZ_DESIGNATION}") endif() string(TOLOWER ${PROJECT_NAME_NO_VERSION} PROJECT_NAME_NO_VERSION_LOWER) string(TOUPPER ${PROJECT_NAME_NO_VERSION} PROJECT_NAME_NO_VERSION_UPPER) string(TOLOWER ${PROJECT_NAME} PROJECT_NAME_LOWER) string(TOUPPER ${PROJECT_NAME} PROJECT_NAME_UPPER) - string(TOLOWER ${IGN_DESIGNATION} IGN_DESIGNATION_LOWER) - string(TOUPPER ${IGN_DESIGNATION} IGN_DESIGNATION_UPPER) + string(TOLOWER ${GZ_DESIGNATION} GZ_DESIGNATION_LOWER) + string(TOUPPER ${GZ_DESIGNATION} GZ_DESIGNATION_UPPER) - string(SUBSTRING ${IGN_DESIGNATION} 0 1 IGN_DESIGNATION_FIRST_LETTER) - string(TOUPPER ${IGN_DESIGNATION_FIRST_LETTER} IGN_DESIGNATION_FIRST_LETTER) - string(REGEX REPLACE "^.(.*)" "${IGN_DESIGNATION_FIRST_LETTER}\\1" - IGN_DESIGNATION_CAP "${IGN_DESIGNATION}") + string(SUBSTRING ${GZ_DESIGNATION} 0 1 GZ_DESIGNATION_FIRST_LETTER) + string(TOUPPER ${GZ_DESIGNATION_FIRST_LETTER} GZ_DESIGNATION_FIRST_LETTER) + string(REGEX REPLACE "^.(.*)" "${GZ_DESIGNATION_FIRST_LETTER}\\1" + GZ_DESIGNATION_CAP "${GZ_DESIGNATION}") + + set(IGN_DESIGNATION ${GZ_DESIGNATION}) # TODO(CH3): Deprecated. Remove on tock. + set(IGN_DESIGNATION_LOWER ${GZ_DESIGNATION_LOWER}) # TODO(CH3): Deprecated. Remove on tock. + set(IGN_DESIGNATION_UPPER ${GZ_DESIGNATION_UPPER}) # TODO(CH3): Deprecated. Remove on tock. + set(IGN_DESIGNATION_FIRST_LETTER ${GZ_DESIGNATION_FIRST_LETTER}) # TODO(CH3): Deprecated. Remove on tock. + set(IGN_DESIGNATION_CAP ${GZ_DESIGNATION_CAP}) # TODO(CH3): Deprecated. Remove on tock. set(PROJECT_EXPORT_NAME ${PROJECT_NAME_LOWER}) set(PROJECT_LIBRARY_TARGET_NAME ${PROJECT_NAME_LOWER}) - if(gz_configure_project_REPLACE_IGNITION_INCLUDE_PATH) + if(gz_configure_project_REPLACE_INCLUDE_PATH) + set(PROJECT_INCLUDE_DIR ${gz_configure_project_REPLACE_INCLUDE_PATH}) + elseif(gz_configure_project_REPLACE_IGNITION_INCLUDE_PATH) # TODO(CH3): REPLACE_IGNITION_INCLUDE_PATH IS DEPRECATED. + message(DEPRECATION "[REPLACE_IGNITION_INCLUDE_PATH] is deprecated. Please use [REPLACE_INCLUDE_PATH] instead!") set(PROJECT_INCLUDE_DIR ${gz_configure_project_REPLACE_IGNITION_INCLUDE_PATH}) else() - set(PROJECT_INCLUDE_DIR ignition/${IGN_DESIGNATION}) + set(PROJECT_INCLUDE_DIR gz/${GZ_DESIGNATION}) endif() # version . diff --git a/cmake/GzCreateDocs.cmake b/cmake/GzCreateDocs.cmake index 3e234233..743368c0 100644 --- a/cmake/GzCreateDocs.cmake +++ b/cmake/GzCreateDocs.cmake @@ -99,9 +99,9 @@ function(gz_create_docs) # doxygen does not generate an html file if the necessary content is not # present in a project. For example, the "hierarchy.html" may not be # generated in a project that has no class hierarchy. - file(READ "${IGNITION_CMAKE_DOXYGEN_DIR}/header.html" doxygen_header) - file(READ "${IGNITION_CMAKE_DOXYGEN_DIR}/footer.html" doxygen_footer) - string(REGEX REPLACE "\\$projectname" "Ignition ${IGN_DESIGNATION_CAP}" + file(READ "${GZ_CMAKE_DOXYGEN_DIR}/header.html" doxygen_header) + file(READ "${GZ_CMAKE_DOXYGEN_DIR}/footer.html" doxygen_footer) + string(REGEX REPLACE "\\$projectname" "Gazebo ${GZ_DESIGNATION_CAP}" doxygen_header ${doxygen_header}) string(REGEX REPLACE "\\$projectnumber" "${PROJECT_VERSION_FULL}" doxygen_header ${doxygen_header}) @@ -124,57 +124,57 @@ function(gz_create_docs) #-------------------------------------- # Configure documentation uploader - configure_file("${IGNITION_CMAKE_DIR}/upload_doc.sh.in" + configure_file("${GZ_CMAKE_DIR}/upload_doc.sh.in" ${CMAKE_BINARY_DIR}/upload_doc.sh @ONLY) #-------------------------------------- # Create man pages include(GzRonn2Man) - ign_add_manpage_target() + gz_add_manpage_target() - set(IGNITION_DOXYGEN_API_MAINPAGE_MD ${gz_create_docs_API_MAINPAGE_MD}) - set(IGNITION_DOXYGEN_AUTOGENERATED_DOC ${gz_create_docs_AUTOGENERATED_DOC}) - set(IGNITION_DOXYGEN_TUTORIALS_MAINPAGE_MD + set(GZ_DOXYGEN_API_MAINPAGE_MD ${gz_create_docs_API_MAINPAGE_MD}) + set(GZ_DOXYGEN_AUTOGENERATED_DOC ${gz_create_docs_AUTOGENERATED_DOC}) + set(GZ_DOXYGEN_TUTORIALS_MAINPAGE_MD ${gz_create_docs_TUTORIALS_MAINPAGE_MD}) - set(IGNITION_DOXYGEN_TAGFILES " ") + set(GZ_DOXYGEN_TAGFILES " ") foreach(tagfile ${gz_create_docs_TAGFILES}) - gz_string_append(IGNITION_DOXYGEN_TAGFILES "\"${tagfile}\"" DELIM " \\\\\\\\\n ") + gz_string_append(GZ_DOXYGEN_TAGFILES "\"${tagfile}\"" DELIM " \\\\\\\\\n ") endforeach() - set(IGNITION_DOXYGEN_ADDITIONAL_INPUT_DIRS " ") + set(GZ_DOXYGEN_ADDITIONAL_INPUT_DIRS " ") foreach(dir ${gz_create_docs_ADDITIONAL_INPUT_DIRS}) - gz_string_append(IGNITION_DOXYGEN_ADDITIONAL_INPUT_DIRS "${dir}") + gz_string_append(GZ_DOXYGEN_ADDITIONAL_INPUT_DIRS "${dir}") endforeach() - set(IGNITION_DOXYGEN_IMAGE_PATH " ") + set(GZ_DOXYGEN_IMAGE_PATH " ") foreach(dir ${gz_create_docs_IMAGE_PATH_DIRS}) - gz_string_append(IGNITION_DOXYGEN_IMAGE_PATH "${dir}") + gz_string_append(GZ_DOXYGEN_IMAGE_PATH "${dir}") endforeach() find_package(Doxygen) - if (DOXYGEN_FOUND AND EXISTS ${IGNITION_CMAKE_DOXYGEN_DIR}/api.in) + if (DOXYGEN_FOUND AND EXISTS ${GZ_CMAKE_DOXYGEN_DIR}/api.in) if(EXISTS ${CMAKE_SOURCE_DIR}/tutorials) - set(IGNITION_DOXYGEN_TUTORIALS_DIR ${CMAKE_SOURCE_DIR}/tutorials) + set(GZ_DOXYGEN_TUTORIALS_DIR ${CMAKE_SOURCE_DIR}/tutorials) else() - set(IGNITION_DOXYGEN_TUTORIALS_DIR "") + set(GZ_DOXYGEN_TUTORIALS_DIR "") endif() # Configure the main API+Tutorials doxygen configuration file. This # configuration file is not used to generate the doxygen tag file, # see below. - set(IGNITION_DOXYGEN_GENHTML "YES") + set(GZ_DOXYGEN_GENHTML "YES") - # Be careful when manipulating IGNITION_DOXYGEN_INPUT. Doxygen is finicky + # Be careful when manipulating GZ_DOXYGEN_INPUT. Doxygen is finicky # about the spaces between input files/directories. If you put each cmake # variable on a separate line to make this `set` command more readable, # then doxygen will not generate the correct/complete output. - set(IGNITION_DOXYGEN_INPUT "${IGNITION_DOXYGEN_API_MAINPAGE_MD} ${IGNITION_DOXYGEN_AUTOGENERATED_DOC} ${IGNITION_DOXYGEN_TUTORIALS_DIR} ${IGNITION_DOXYGEN_TUTORIALS_MAINPAGE_MD} ${gz_doxygen_component_input_dirs} ${IGNITION_DOXYGEN_ADDITIONAL_INPUT_DIRS}") - configure_file(${IGNITION_CMAKE_DOXYGEN_DIR}/api.in + set(GZ_DOXYGEN_INPUT "${GZ_DOXYGEN_API_MAINPAGE_MD} ${GZ_DOXYGEN_AUTOGENERATED_DOC} ${GZ_DOXYGEN_TUTORIALS_DIR} ${GZ_DOXYGEN_TUTORIALS_MAINPAGE_MD} ${gz_doxygen_component_input_dirs} ${GZ_DOXYGEN_ADDITIONAL_INPUT_DIRS}") + configure_file(${GZ_CMAKE_DOXYGEN_DIR}/api.in ${CMAKE_BINARY_DIR}/api.dox @ONLY) # The doxygen tagfile should not contain tutorial information. If tutorial @@ -184,11 +184,11 @@ function(gz_create_docs) # satisfy this constraint we generate another doxygen configuration file # whose sole purpose is the generation of a project's doxygen tagfile that # contains only API information. - set(IGNITION_DOXYGEN_GENHTML "NO") - set(IGNITION_DOXYGEN_GENTAGFILE + set(GZ_DOXYGEN_GENHTML "NO") + set(GZ_DOXYGEN_GENTAGFILE "${CMAKE_BINARY_DIR}/${PROJECT_NAME_LOWER}.tag.xml") - set(IGNITION_DOXYGEN_INPUT "${gz_doxygen_component_input_dirs} ${IGNITION_DOXYGEN_AUTOGENERATED_DOC}") - configure_file(${IGNITION_CMAKE_DOXYGEN_DIR}/api.in + set(GZ_DOXYGEN_INPUT "${gz_doxygen_component_input_dirs} ${GZ_DOXYGEN_AUTOGENERATED_DOC}") + configure_file(${GZ_CMAKE_DOXYGEN_DIR}/api.in ${CMAKE_BINARY_DIR}/api_tagfile.dox @ONLY) add_custom_target(doc ALL @@ -201,7 +201,7 @@ function(gz_create_docs) COMMENT "Generating API documentation with Doxygen" VERBATIM) install(FILES ${CMAKE_BINARY_DIR}/${PROJECT_NAME_LOWER}.tag.xml - DESTINATION ${IGN_DATA_INSTALL_DIR}) + DESTINATION ${GZ_DATA_INSTALL_DIR}) endif() #-------------------------------------- diff --git a/cmake/GzGenerateVersionInfo.cmake b/cmake/GzGenerateVersionInfo.cmake index 06ecfd75..dd52ea9b 100644 --- a/cmake/GzGenerateVersionInfo.cmake +++ b/cmake/GzGenerateVersionInfo.cmake @@ -3,7 +3,7 @@ # ---------------------- # # Intended to be invoked as part of the _gz_add_version_info_target function -# in IgnBenchmark. +# in GzBenchmark. # # Populates information in the version_info.json file. # diff --git a/cmake/GzPackaging.cmake b/cmake/GzPackaging.cmake index e9c0e845..a67ac7e2 100644 --- a/cmake/GzPackaging.cmake +++ b/cmake/GzPackaging.cmake @@ -75,7 +75,7 @@ macro(_gz_setup_packages) if(CPACK_GENERATOR) message(STATUS "Found CPack generators: ${CPACK_GENERATOR}") - configure_file("${IGNITION_CMAKE_DIR}/cpack_options.cmake.in" + configure_file("${GZ_CMAKE_DIR}/cpack_options.cmake.in" ${PROJECT_CPACK_CFG_FILE} @ONLY) set(CPACK_PROJECT_CONFIG_FILE ${PROJECT_CPACK_CFG_FILE}) @@ -103,13 +103,21 @@ macro(_gz_setup_packages) #============================================================================ # Set up installation directories - set(IGN_INCLUDE_INSTALL_DIR "${CMAKE_INSTALL_INCLUDEDIR}") - set(IGN_INCLUDE_INSTALL_DIR_POSTFIX "ignition/${IGN_DESIGNATION}${PROJECT_VERSION_MAJOR}") - set(IGN_INCLUDE_INSTALL_DIR_FULL "${IGN_INCLUDE_INSTALL_DIR}/${IGN_INCLUDE_INSTALL_DIR_POSTFIX}") - set(IGN_DATA_INSTALL_DIR_POSTFIX "ignition/${PROJECT_NAME_LOWER}") - set(IGN_DATA_INSTALL_DIR "${CMAKE_INSTALL_DATAROOTDIR}/${IGN_DATA_INSTALL_DIR_POSTFIX}") - set(IGN_LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR}) - set(IGN_BIN_INSTALL_DIR ${CMAKE_INSTALL_BINDIR}) + set(GZ_INCLUDE_INSTALL_DIR "${CMAKE_INSTALL_INCLUDEDIR}") + set(GZ_INCLUDE_INSTALL_DIR_POSTFIX "gz/${GZ_DESIGNATION}${PROJECT_VERSION_MAJOR}") + set(GZ_INCLUDE_INSTALL_DIR_FULL "${GZ_INCLUDE_INSTALL_DIR}/${GZ_INCLUDE_INSTALL_DIR_POSTFIX}") + set(GZ_DATA_INSTALL_DIR_POSTFIX "gz/${PROJECT_NAME_LOWER}") + set(GZ_DATA_INSTALL_DIR "${CMAKE_INSTALL_DATAROOTDIR}/${GZ_DATA_INSTALL_DIR_POSTFIX}") + set(GZ_LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR}) + set(GZ_BIN_INSTALL_DIR ${CMAKE_INSTALL_BINDIR}) + + set(IGN_INCLUDE_INSTALL_DIR ${GZ_INCLUDE_INSTALL_DIR}) # TODO(CH3): Deprecated. Remove on tock. + set(IGN_INCLUDE_INSTALL_DIR_POSTFIX ${GZ_INCLUDE_INSTALL_DIR_POSTFIX}) # TODO(CH3): Deprecated. Remove on tock. + set(IGN_INCLUDE_INSTALL_DIR_FULL ${GZ_INCLUDE_INSTALL_DIR_FULL}) # TODO(CH3): Deprecated. Remove on tock. + set(IGN_DATA_INSTALL_DIR_POSTFIX ${GZ_DATA_INSTALL_DIR_POSTFIX}) # TODO(CH3): Deprecated. Remove on tock. + set(IGN_DATA_INSTALL_DIR ${GZ_DATA_INSTALL_DIR}) # TODO(CH3): Deprecated. Remove on tock. + set(IGN_LIB_INSTALL_DIR ${GZ_LIB_INSTALL_DIR}) # TODO(CH3): Deprecated. Remove on tock. + set(IGN_BIN_INSTALL_DIR ${GZ_BIN_INSTALL_DIR}) # TODO(CH3): Deprecated. Remove on tock. #============================================================================ # Handle the user's RPATH setting @@ -122,23 +130,23 @@ macro(_gz_setup_packages) # (but later on when installing) set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE) - set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}") + set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${GZ_LIB_INSTALL_DIR}") # add the automatically determined parts of the RPATH # which point to directories outside the build tree to the install RPATH set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE) # the RPATH to be used when installing, but only if its not a system directory - list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}" isSystemDir) + list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/${GZ_LIB_INSTALL_DIR}" isSystemDir) if("${isSystemDir}" STREQUAL "-1") - set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}") + set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${GZ_LIB_INSTALL_DIR}") endif("${isSystemDir}" STREQUAL "-1") endif() #============================================================================ # Add uninstall target configure_file( - "${IGNITION_CMAKE_DIR}/cmake_uninstall.cmake.in" + "${GZ_CMAKE_DIR}/cmake_uninstall.cmake.in" "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake" IMMEDIATE @ONLY) add_custom_target(uninstall @@ -197,15 +205,15 @@ function(_gz_create_pkgconfig) #------------------------------------ # Choose which input file to use if(_gz_create_pkgconfig_COMPONENT) - set(pkgconfig_input "${IGNITION_CMAKE_DIR}/pkgconfig/gz-component.pc.in") + set(pkgconfig_input "${GZ_CMAKE_DIR}/pkgconfig/gz-component.pc.in") set(target_name ${PROJECT_LIBRARY_TARGET_NAME}-${_gz_create_pkgconfig_COMPONENT}) else() - set(pkgconfig_input "${IGNITION_CMAKE_DIR}/pkgconfig/gz.pc.in") + set(pkgconfig_input "${GZ_CMAKE_DIR}/pkgconfig/gz.pc.in") set(target_name ${PROJECT_LIBRARY_TARGET_NAME}) endif() set(pkgconfig_output "${CMAKE_BINARY_DIR}/cmake/pkgconfig/${target_name}.pc") - set(pkgconfig_install_dir "${IGN_LIB_INSTALL_DIR}/pkgconfig") + set(pkgconfig_install_dir "${GZ_LIB_INSTALL_DIR}/pkgconfig") file(RELATIVE_PATH PC_CONFIG_RELATIVE_PATH_TO_PREFIX "${CMAKE_INSTALL_PREFIX}/${pkgconfig_install_dir}" @@ -270,12 +278,12 @@ function(_gz_create_cmake_package) set(component ${_gz_create_cmake_package_COMPONENT}) set(target_name ${PROJECT_LIBRARY_TARGET_NAME}-${component}) - set(gz_config_input "${IGNITION_CMAKE_DIR}/gz-component-config.cmake.in") + set(gz_config_input "${GZ_CMAKE_DIR}/gz-component-config.cmake.in") set(simple_import_name ${component}) elseif(_gz_create_cmake_package_ALL) - set(gz_config_input "${IGNITION_CMAKE_DIR}/gz-all-config.cmake.in") + set(gz_config_input "${GZ_CMAKE_DIR}/gz-all-config.cmake.in") set(target_name ${PROJECT_LIBRARY_TARGET_NAME}-all) set(all_pkg_name ${PROJECT_LIBRARY_TARGET_NAME}-all) set(simple_import_name all) @@ -283,7 +291,7 @@ function(_gz_create_cmake_package) else() set(target_name ${PROJECT_LIBRARY_TARGET_NAME}) - set(gz_config_input "${IGNITION_CMAKE_DIR}/gz-config.cmake.in") + set(gz_config_input "${GZ_CMAKE_DIR}/gz-config.cmake.in") set(simple_import_name core) endif() @@ -306,20 +314,20 @@ function(_gz_create_cmake_package) # NOTE: Each component needs to go into its own cmake directory in order to be # found by cmake's native find_package(~) command. - set(gz_config_install_dir "${IGN_LIB_INSTALL_DIR}/cmake/${target_name}") + set(gz_config_install_dir "${GZ_LIB_INSTALL_DIR}/cmake/${target_name}") set(gz_namespace ${PROJECT_LIBRARY_TARGET_NAME}::) set(import_target_name ${gz_namespace}${target_name}) set(simple_import_name ${gz_namespace}${simple_import_name}) # Configure the package config file. It will be installed to - # "[lib]/cmake/ignition-/" where [lib] is the library + # "[lib]/cmake/gz-/" where [lib] is the library # installation directory. configure_package_config_file( ${gz_config_input} ${gz_config_output} INSTALL_DESTINATION ${gz_config_install_dir} - PATH_VARS IGN_LIB_INSTALL_DIR IGN_INCLUDE_INSTALL_DIR_FULL) + PATH_VARS GZ_LIB_INSTALL_DIR GZ_INCLUDE_INSTALL_DIR_FULL) # Use write_basic_package_version_file to generate a ConfigVersion file that # allow users of the library to specify the API or version to depend on @@ -343,10 +351,10 @@ function(_gz_create_cmake_package) # We add a namespace that ends with a :: to the name of the exported target. # This is so consumers of the project can call # find_package(gz-) - # target_link_libraries(consumer_project ignition-::ignition-) + # target_link_libraries(consumer_project gz-::gz-) # and cmake will understand that the consumer is asking to link the imported - # target "ignition-" to their "consumer_project" rather than asking - # to link a library named "ignition-". In other words, when + # target "gz-" to their "consumer_project" rather than asking + # to link a library named "gz-". In other words, when # target_link_libraries is given a name that contains double-colons (::) it # will never mistake it for a library name, and it will throw an error if # it cannot find a target with the given name. diff --git a/cmake/GzPython.cmake b/cmake/GzPython.cmake index d5115a59..2e320913 100644 --- a/cmake/GzPython.cmake +++ b/cmake/GzPython.cmake @@ -13,24 +13,26 @@ # limitations under the License. if(${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.19") - set(IGN_PYTHON_VERSION "" CACHE STRING + set(GZ_PYTHON_VERSION "" CACHE STRING "Specify specific Python3 version to use ('major.minor' or 'versionMin...[<]versionMax')") + set(IGN_PYTHON_VERSION ${GZ_PYTHON_VERSION} CACHE STRING # TODO(CH3): Deprecated. Remove on tock. + "Deprecated. Use [GZ_PYTHON_VERSION] instead! Specify specific Python version to use ('major.minor' or 'major')") - find_package(Python3 ${IGN_PYTHON_VERSION} QUIET) + find_package(Python3 ${GZ_PYTHON_VERSION} QUIET) elseif(${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.12") # no support for finding specific versions find_package(Python3 QUIET) else() # TODO: remove this block as soon as the CMake version can safely be bumped to => 3.12 - set(IGN_PYTHON_VERSION "" CACHE STRING + set(GZ_PYTHON_VERSION "" CACHE STRING "Specify specific Python version to use ('major.minor' or 'major')") # if not specified otherwise use Python 3 - if(NOT IGN_PYTHON_VERSION) - set(IGN_PYTHON_VERSION "3") + if(NOT GZ_PYTHON_VERSION) + set(GZ_PYTHON_VERSION "3") endif() - find_package(PythonInterp ${IGN_PYTHON_VERSION} QUIET) + find_package(PythonInterp ${GZ_PYTHON_VERSION} QUIET) if(PYTHONINTERP_FOUND) set(Python3_Interpreter_FOUND ${PYTHONINTERP_FOUND}) diff --git a/cmake/GzRonn2Man.cmake b/cmake/GzRonn2Man.cmake index 29900aca..ab6284d5 100644 --- a/cmake/GzRonn2Man.cmake +++ b/cmake/GzRonn2Man.cmake @@ -8,12 +8,12 @@ # - Tweaked macro name to avoid name collisions # -MACRO(IGN_ADD_MANPAGE_TARGET) +MACRO(gz_add_manpage_target) # It is not possible add a dependency to target 'install' # Run hard-coded 'make man' when 'make install' is invoked INSTALL(CODE "EXECUTE_PROCESS(COMMAND $(MAKE) man)") ADD_CUSTOM_TARGET(man) -ENDMACRO(IGN_ADD_MANPAGE_TARGET) +ENDMACRO(gz_add_manpage_target) FIND_PROGRAM(RONN ronn) FIND_PROGRAM(GZIP gzip) diff --git a/cmake/GzSanitizers.cmake b/cmake/GzSanitizers.cmake index d531f460..644558c0 100644 --- a/cmake/GzSanitizers.cmake +++ b/cmake/GzSanitizers.cmake @@ -17,11 +17,16 @@ include(CheckCXXSourceCompiles) -set(IGN_SANITIZER "" +set(GZ_SANITIZER "" CACHE STRING "Compile with a sanitizer. Options are: Address, Memory, MemoryWithOrigins, Undefined, Thread, Leak, 'Address;Undefined', CFI" ) +set(IGN_SANITIZER "" # TODO(CH3): Deprecated. Remove on tock. + CACHE STRING + "Deprecated. Please use [GZ_SANITIZER]. Compile with a sanitizer. Options are: Address, Memory, MemoryWithOrigins, Undefined, Thread, Leak, 'Address;Undefined', CFI" +) + function(append value) foreach(variable ${ARGN}) set(${variable} @@ -49,13 +54,18 @@ function(test_san_flags return_var flags) set(CMAKE_REQUIRED_QUIET "${QUIET_BACKUP}") endfunction() -if(IGN_SANITIZER) +if(NOT GZ_SANITIZER AND IGN_SANITIZER) # TODO(CH3): Deprecated. Remove on tock. + message(DEPRECATION "Ign prefixed variable [IGN_SANITIZER] is deprecated! Use [GZ_SANITIZER] instead!") + set(GZ_SANITIZER ${IGN_SANITIZER}) +endif() + +if(GZ_SANITIZER) append("-fno-omit-frame-pointer" CMAKE_C_FLAGS CMAKE_CXX_FLAGS) unset(SANITIZER_SELECTED_FLAGS) if(UNIX) - if(IGN_SANITIZER MATCHES "([Aa]ddress)") + if(GZ_SANITIZER MATCHES "([Aa]ddress)") # Optional: -fno-optimize-sibling-calls -fsanitize-address-use-after-scope message(STATUS "Testing with Address sanitizer") set(SANITIZER_ADDR_FLAG "-fsanitize=address") @@ -75,10 +85,10 @@ if(IGN_SANITIZER) endif() endif() - if(IGN_SANITIZER MATCHES "([Mm]emory([Ww]ith[Oo]rigins)?)") + if(GZ_SANITIZER MATCHES "([Mm]emory([Ww]ith[Oo]rigins)?)") # Optional: -fno-optimize-sibling-calls -fsanitize-memory-track-origins=2 set(SANITIZER_MEM_FLAG "-fsanitize=memory") - if(IGN_SANITIZER MATCHES "([Mm]emory[Ww]ith[Oo]rigins)") + if(GZ_SANITIZER MATCHES "([Mm]emory[Ww]ith[Oo]rigins)") message(STATUS "Testing with MemoryWithOrigins sanitizer") append("-fsanitize-memory-track-origins" SANITIZER_MEM_FLAG) else() @@ -86,7 +96,7 @@ if(IGN_SANITIZER) endif() test_san_flags(SANITIZER_MEM_AVAILABLE ${SANITIZER_MEM_FLAG}) if(SANITIZER_MEM_AVAILABLE) - if(IGN_SANITIZER MATCHES "([Mm]emory[Ww]ith[Oo]rigins)") + if(GZ_SANITIZER MATCHES "([Mm]emory[Ww]ith[Oo]rigins)") message(STATUS " Building with MemoryWithOrigins sanitizer") else() message(STATUS " Building with Memory sanitizer") @@ -105,7 +115,7 @@ if(IGN_SANITIZER) endif() endif() - if(IGN_SANITIZER MATCHES "([Uu]ndefined)") + if(GZ_SANITIZER MATCHES "([Uu]ndefined)") message(STATUS "Testing with Undefined Behaviour sanitizer") set(SANITIZER_UB_FLAG "-fsanitize=undefined") if(EXISTS "${BLACKLIST_FILE}") @@ -128,7 +138,7 @@ if(IGN_SANITIZER) endif() endif() - if(IGN_SANITIZER MATCHES "([Tt]hread)") + if(GZ_SANITIZER MATCHES "([Tt]hread)") message(STATUS "Testing with Thread sanitizer") set(SANITIZER_THREAD_FLAG "-fsanitize=thread") test_san_flags(SANITIZER_THREAD_AVAILABLE ${SANITIZER_THREAD_FLAG}) @@ -147,7 +157,7 @@ if(IGN_SANITIZER) endif() endif() - if(IGN_SANITIZER MATCHES "([Ll]eak)") + if(GZ_SANITIZER MATCHES "([Ll]eak)") message(STATUS "Testing with Leak sanitizer") set(SANITIZER_LEAK_FLAG "-fsanitize=leak") test_san_flags(SANITIZER_LEAK_AVAILABLE ${SANITIZER_LEAK_FLAG}) @@ -166,7 +176,7 @@ if(IGN_SANITIZER) endif() endif() - if(IGN_SANITIZER MATCHES "([Cc][Ff][Ii])") + if(GZ_SANITIZER MATCHES "([Cc][Ff][Ii])") message(STATUS "Testing with Control Flow Integrity(CFI) sanitizer") set(SANITIZER_CFI_FLAG "-fsanitize=cfi") test_san_flags(SANITIZER_CFI_AVAILABLE ${SANITIZER_CFI_FLAG}) @@ -197,7 +207,7 @@ if(IGN_SANITIZER) " Sanitizer flags ${SANITIZER_SELECTED_FLAGS} are not compatible.") endif() elseif(MSVC) - if(IGN_SANITIZER MATCHES "([Aa]ddress)") + if(GZ_SANITIZER MATCHES "([Aa]ddress)") message(STATUS "Building with Address sanitizer") append("-fsanitize=address" CMAKE_C_FLAGS CMAKE_CXX_FLAGS) @@ -208,11 +218,11 @@ if(IGN_SANITIZER) else() message( FATAL_ERROR - "This sanitizer not yet supported in the MSVC environment: ${IGN_SANITIZER}" + "This sanitizer not yet supported in the MSVC environment: ${GZ_SANITIZER}" ) endif() else() - message(FATAL_ERROR "IGN_SANITIZER is not supported on this platform.") + message(FATAL_ERROR "GZ_SANITIZER is not supported on this platform.") endif() endif() diff --git a/cmake/GzSetCompilerFlags.cmake b/cmake/GzSetCompilerFlags.cmake index 4052c5fb..655376b2 100644 --- a/cmake/GzSetCompilerFlags.cmake +++ b/cmake/GzSetCompilerFlags.cmake @@ -26,7 +26,7 @@ # Internal to gz-cmake. macro(_gz_set_compiler_flags) - option(USE_IGN_RECOMMENDED_FLAGS "Build project using the compiler flags recommended by the ignition developers" ON) + option(USE_GZ_RECOMMENDED_FLAGS "Build project using the compiler flags recommended by the Gazebo developers" ON) if(MSVC) _gz_setup_msvc() @@ -56,7 +56,7 @@ macro(_gz_set_compiler_flags) if(GCC_OR_CLANG) - if(USE_IGN_RECOMMENDED_FLAGS) + if(USE_GZ_RECOMMENDED_FLAGS) _gz_setup_gcc_or_clang() endif() @@ -80,7 +80,8 @@ macro(_gz_setup_unix) set(CMAKE_SYSTEM_PROCESSOR ${CMAKE_SYSTEM_PROCESSOR} CACHE INTERNAL "processor type (i386 and x86_64)") if(CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64") - set(IGN_ADD_fPIC_TO_LIBRARIES true) + set(GZ_ADD_fPIC_TO_LIBRARIES true) + set(IGN_ADD_fPIC_TO_LIBRARIES ${GZ_ADD_fPIC_TO_LIBRARIES}) # TODO(CH3): Deprecated. Remove on tock. endif(CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64") endif(CMAKE_UNAME) @@ -294,7 +295,7 @@ macro(_gz_setup_msvc) # Don't pull in the Windows min/max macros add_definitions(-DNOMINMAX) - if(USE_IGN_RECOMMENDED_FLAGS) + if(USE_GZ_RECOMMENDED_FLAGS) # Gy: Prevent errors caused by multiply-defined symbols # W2: Warning level 2: significant warnings. @@ -347,17 +348,24 @@ macro(_gz_setup_msvc) # framework. # # In some cases, a user might want to compile with the static runtime. This - # should ONLY be done if they do not intend to use the ignition library as + # should ONLY be done if they do not intend to use the Gazebo library as # part of a plugin-based framework. - option(IGN_USE_STATIC_RUNTIME "Use the static runtime (strongly discouraged)" OFF) + + if(IGN_USE_STATIC_RUNTIME) # TODO(CH3): Deprecated. Remove on tock. + message(WARNING "Deprecated. Use [GZ_USE_STATIC_RUNTIME] instead! Use the static runtime (strongly discouraged)") + set(GZ_USE_STATIC_RUNTIME ${IGN_USE_STATIC_RUNTIME}) + else() + option(GZ_USE_STATIC_RUNTIME "Use the static runtime (strongly discouraged)" OFF) + endif() + if(BUILD_SHARED_LIBS) # Users should not choose the static runtime unless they are compiling a # static library, so we completely disable this option if BUILD_SHARED_LIBS # is turned on. - set(IGN_USE_STATIC_RUNTIME OFF CACHE BOOL "Use the static runtime (strongly discouraged)" FORCE) + set(GZ_USE_STATIC_RUNTIME OFF CACHE BOOL "Use the static runtime (strongly discouraged)" FORCE) endif() - if(IGN_USE_STATIC_RUNTIME) + if(GZ_USE_STATIC_RUNTIME) foreach(build_type DEBUG RELEASE RELWITHDEBINFO MINSIZEREL NONE) foreach(lang C CXX) set(flags_var CMAKE_${lang}_FLAGS_${build_type}) diff --git a/cmake/GzUtils.cmake b/cmake/GzUtils.cmake index 732b5ed9..8ed3a2a3 100644 --- a/cmake/GzUtils.cmake +++ b/cmake/GzUtils.cmake @@ -15,7 +15,7 @@ # [PKGCONFIG_VER_COMPARISON < > = <= >= ]) # # This is a wrapper for the standard cmake find_package which behaves according -# to the conventions of the ignition library. In particular, we do not quit +# to the conventions of the Gazebo library. In particular, we do not quit # immediately when a required package is missing. Instead, we check all # dependencies and provide an overview of what is missing at the end of the # configuration process. Descriptions of the function arguments are as follows: @@ -31,9 +31,9 @@ # alternative names for this package that can be used depending # on the context. # -# [REQUIRED]: Optional. If provided, macro will trigger an ignition build_error +# [REQUIRED]: Optional. If provided, macro will trigger a Gazebo build_error # when the package cannot be found. If not provided, this macro will -# trigger an ignition build_warning when the package is not found. +# trigger a Gazebo build_warning when the package is not found. # To specify that something is required by some set of components # (rather than the core library), use REQUIRED_BY. # @@ -205,7 +205,7 @@ macro(gz_find_package PACKAGE_NAME_) # TODO(CH3): Deprecated. Remove on tock. if(${PACKAGE_NAME} MATCHES "^Ign") - # Deliberately use QUIET since we expect Ign to fail + # NOTE(CH3): Deliberately use QUIET since we expect Ign to fail find_package(${${PACKAGE_NAME}_find_package_args} QUIET) if(NOT ${PACKAGE_NAME}_FOUND) @@ -227,7 +227,7 @@ macro(gz_find_package PACKAGE_NAME_) endif() else() - # TODO(CH3): On removal of tock, unindent this and just have this line!! + # TODO(CH3): On removal on tock, unindent this and just have this line!! find_package(${${PACKAGE_NAME}_find_package_args}) endif() @@ -308,7 +308,7 @@ macro(gz_find_package PACKAGE_NAME_) AND NOT gz_find_package_BUILD_ONLY) # Set up the arguments we want to pass to the find_dependency invokation for - # our ignition project. We always need to pass the name of the dependency. + # our Gazebo project. We always need to pass the name of the dependency. # # NOTE: We escape the dollar signs because we want those variable # evaluations to be a part of the string that we produce. It is going @@ -439,10 +439,10 @@ macro(gz_find_package PACKAGE_NAME_) # provided pkg-config information. The caller has also not specified # PKGCONFIG_IGNORE. This means that the requirements of this package # will be unintentionally omitted from the auto-generated - # ignition-.pc file. This is probably an oversight in our build + # gz-.pc file. This is probably an oversight in our build # system scripts, so we will emit a warning about this. message(AUTHOR_WARNING - " -- THIS MESSAGE IS INTENDED FOR GZ-${IGN_DESIGNATION_UPPER} AUTHORS --\n" + " -- THIS MESSAGE IS INTENDED FOR GZ-${GZ_DESIGNATION_UPPER} AUTHORS --\n" " (IF YOU SEE THIS, PLEASE REPORT IT)\n" "Could not find pkg-config information for ${PACKAGE_NAME}. " "It was not provided by the find-module for the package, nor was it " @@ -696,7 +696,7 @@ endfunction() # additional suffix (like .old or .backup) to prevent a file from being included. # # GENERATED_HEADERS should be generated headers which should be included by -# ${IGN_DESIGNATION}.hh. This will only add them to the header, it will not +# ${GZ_DESIGNATION}.hh. This will only add them to the header, it will not # generate or install them. # # This will also run configure_file on gz_auto_headers.hh.in and config.hh.in @@ -792,13 +792,13 @@ function(gz_install_all_headers) # Add each header, prefixed by its directory, to the auto headers variable foreach(header ${headers}) - set(ign_headers "${ign_headers}#include <${PROJECT_INCLUDE_DIR}/${header}>\n") + set(gz_headers "${gz_headers}#include <${PROJECT_INCLUDE_DIR}/${header}>\n") endforeach() if("." STREQUAL ${dir}) - set(destination "${IGN_INCLUDE_INSTALL_DIR_FULL}/${PROJECT_INCLUDE_DIR}") + set(destination "${GZ_INCLUDE_INSTALL_DIR_FULL}/${PROJECT_INCLUDE_DIR}") else() - set(destination "${IGN_INCLUDE_INSTALL_DIR_FULL}/${PROJECT_INCLUDE_DIR}/${dir}") + set(destination "${GZ_INCLUDE_INSTALL_DIR_FULL}/${PROJECT_INCLUDE_DIR}/${dir}") endif() install( @@ -810,28 +810,30 @@ function(gz_install_all_headers) # Add generated headers to the list of includes foreach(header ${gz_install_all_headers_GENERATED_HEADERS}) - set(ign_headers "${ign_headers}#include <${PROJECT_INCLUDE_DIR}/${header}>\n") + set(gz_headers "${gz_headers}#include <${PROJECT_INCLUDE_DIR}/${header}>\n") endforeach() + set(ign_headers ${gz_headers}) # TODO(CH3): Deprecated. Remove on tock. + if(gz_install_all_headers_COMPONENT) set(component_name ${gz_install_all_headers_COMPONENT}) # Define the install directory for the component meta header - set(meta_header_install_dir ${IGN_INCLUDE_INSTALL_DIR_FULL}/${PROJECT_INCLUDE_DIR}/${component_name}) + set(meta_header_install_dir ${GZ_INCLUDE_INSTALL_DIR_FULL}/${PROJECT_INCLUDE_DIR}/${component_name}) # Define the input/output of the configuration for the component "master" header - set(master_header_in ${IGNITION_CMAKE_DIR}/gz_auto_headers.hh.in) + set(master_header_in ${GZ_CMAKE_DIR}/gz_auto_headers.hh.in) set(master_header_out ${CMAKE_CURRENT_BINARY_DIR}/${component_name}.hh) else() # Define the install directory for the core master meta header - set(meta_header_install_dir ${IGN_INCLUDE_INSTALL_DIR_FULL}/${PROJECT_INCLUDE_DIR}) + set(meta_header_install_dir ${GZ_INCLUDE_INSTALL_DIR_FULL}/${PROJECT_INCLUDE_DIR}) # Define the input/output of the configuration for the core "master" header - set(master_header_in ${IGNITION_CMAKE_DIR}/gz_auto_headers.hh.in) - set(master_header_out ${CMAKE_CURRENT_BINARY_DIR}/../${IGN_DESIGNATION}.hh) + set(master_header_in ${GZ_CMAKE_DIR}/gz_auto_headers.hh.in) + set(master_header_out ${CMAKE_CURRENT_BINARY_DIR}/../${GZ_DESIGNATION}.hh) endif() @@ -919,11 +921,11 @@ endmacro(gz_build_warning) # function(_gz_check_known_cxx_standards standard) - list(FIND IGN_KNOWN_CXX_STANDARDS ${standard} known) + list(FIND GZ_KNOWN_CXX_STANDARDS ${standard} known) if(${known} EQUAL -1) message(FATAL_ERROR "You have specified an unsupported standard: ${standard}. " - "Accepted values are: ${IGN_KNOWN_CXX_STANDARDS}.") + "Accepted values are: ${GZ_KNOWN_CXX_STANDARDS}.") endif() endfunction() @@ -968,12 +970,12 @@ macro(_gz_handle_cxx_standard prefix target pkgconfig_cflags) endif() if(${prefix}_INTERFACE_CXX_STANDARD) - target_compile_features(${target} INTERFACE ${IGN_CXX_${${prefix}_INTERFACE_CXX_STANDARD}_FEATURES}) + target_compile_features(${target} INTERFACE ${GZ_CXX_${${prefix}_INTERFACE_CXX_STANDARD}_FEATURES}) gz_string_append(${pkgconfig_cflags} "-std=c++${${prefix}_INTERFACE_CXX_STANDARD}") endif() if(${prefix}_PRIVATE_CXX_STANDARD) - target_compile_features(${target} PRIVATE ${IGN_CXX_${${prefix}_PRIVATE_CXX_STANDARD}_FEATURES}) + target_compile_features(${target} PRIVATE ${GZ_CXX_${${prefix}_PRIVATE_CXX_STANDARD}_FEATURES}) endif() endmacro() @@ -1072,7 +1074,7 @@ function(gz_create_core_library) _gz_add_library_or_component( LIB_NAME ${PROJECT_LIBRARY_TARGET_NAME} INCLUDE_DIR "${PROJECT_INCLUDE_DIR}" - EXPORT_BASE GZ_${IGN_DESIGNATION_UPPER} + EXPORT_BASE GZ_${GZ_DESIGNATION_UPPER} SOURCES ${sources} ${interface_option}) @@ -1082,7 +1084,7 @@ function(gz_create_core_library) target_include_directories(${PROJECT_LIBRARY_TARGET_NAME} ${property_type} # This is the publicly installed headers directory. - "$" + "$" # This is the in-build version of the core library headers directory. # Generated headers for the core library get placed here. "$" @@ -1158,7 +1160,7 @@ endfunction() # recommended way to produce plugins or library modules. # # : Required. Name of the component. The final name of this library -# and its target will be ignition-- +# and its target will be gz-- # # SOURCES: Required (unless INTERFACE is specified). Specify the source files # that will be used to generate the library. @@ -1169,7 +1171,7 @@ endfunction() # [DEPENDS_ON_COMPONENTS]: Specify a list of other components of this package # that this component depends on. This argument should # be considered mandatory whenever there are -# inter-component dependencies in an ignition package. +# inter-component dependencies in an Gazebo package. # # [INCLUDE_SUBDIR]: Optional. If specified, the public include headers for this # component will go into "ignition///". @@ -1276,7 +1278,7 @@ function(gz_add_component component_name) _gz_add_library_or_component( LIB_NAME ${component_target_name} INCLUDE_DIR "${PROJECT_INCLUDE_DIR}/${include_subdir}" - EXPORT_BASE GZ_${IGN_DESIGNATION_UPPER}_${component_name_upper} + EXPORT_BASE GZ_${GZ_DESIGNATION_UPPER}_${component_name_upper} SOURCES ${sources} ${interface_option}) @@ -1289,8 +1291,8 @@ function(gz_add_component component_name) # include directories automatically. target_include_directories(${component_target_name} ${property_type} - # This is the publicly installed ignition/math headers directory. - "$" + # This is the publicly installed gz/math headers directory. + "$" # This is the in-build version of the core library's headers directory. # Generated headers for this component might get placed here, even if # the component is independent of the core library. @@ -1426,9 +1428,9 @@ function(_gz_create_all_target) install( TARGETS ${PROJECT_LIBRARY_TARGET_NAME}-all EXPORT ${PROJECT_LIBRARY_TARGET_NAME}-all - LIBRARY DESTINATION ${IGN_LIB_INSTALL_DIR} - ARCHIVE DESTINATION ${IGN_LIB_INSTALL_DIR} - RUNTIME DESTINATION ${IGN_BIN_INSTALL_DIR} + LIBRARY DESTINATION ${GZ_LIB_INSTALL_DIR} + ARCHIVE DESTINATION ${GZ_LIB_INSTALL_DIR} + RUNTIME DESTINATION ${GZ_BIN_INSTALL_DIR} COMPONENT libraries) endfunction() @@ -1540,7 +1542,7 @@ macro(_gz_add_library_or_component) #------------------------------------ # Add fPIC if we are supposed to - if(IGN_ADD_fPIC_TO_LIBRARIES AND NOT _gz_add_library_INTERFACE) + if(GZ_ADD_fPIC_TO_LIBRARIES AND NOT _gz_add_library_INTERFACE) target_compile_options(${lib_name} PRIVATE -fPIC) endif() @@ -1568,7 +1570,7 @@ macro(_gz_add_library_or_component) DEPRECATED_MACRO_NAME GZ_DEPRECATED_ALL_VERSIONS) set(install_include_dir - "${IGN_INCLUDE_INSTALL_DIR_FULL}/${include_dir}") + "${GZ_INCLUDE_INSTALL_DIR_FULL}/${include_dir}") # Configure the installation of the automatically generated file. install( @@ -1586,7 +1588,7 @@ macro(_gz_add_library_or_component) string(REGEX REPLACE "^GZ_" "IGNITION_" _gz_export_base ${export_base}) configure_file( - "${IGNITION_CMAKE_DIR}/Export.hh.in" + "${GZ_CMAKE_DIR}/Export.hh.in" "${binary_include_dir}/Export.hh") # Configure the installation of the public-facing header. @@ -1609,9 +1611,9 @@ macro(_gz_add_library_or_component) install( TARGETS ${lib_name} EXPORT ${lib_name} - LIBRARY DESTINATION ${IGN_LIB_INSTALL_DIR} - ARCHIVE DESTINATION ${IGN_LIB_INSTALL_DIR} - RUNTIME DESTINATION ${IGN_BIN_INSTALL_DIR} + LIBRARY DESTINATION ${GZ_LIB_INSTALL_DIR} + ARCHIVE DESTINATION ${GZ_LIB_INSTALL_DIR} + RUNTIME DESTINATION ${GZ_BIN_INSTALL_DIR} COMPONENT libraries) endmacro() @@ -1660,7 +1662,7 @@ macro(ign_install_includes _subdir) endmacro() macro(gz_install_includes _subdir) install(FILES ${ARGN} - DESTINATION ${IGN_INCLUDE_INSTALL_DIR}/${_subdir} COMPONENT headers) + DESTINATION ${GZ_INCLUDE_INSTALL_DIR}/${_subdir} COMPONENT headers) endmacro() ################################################# @@ -1671,7 +1673,7 @@ macro(ign_install_executable _name ) endmacro() macro(gz_install_executable _name) set_target_properties(${_name} PROPERTIES VERSION ${PROJECT_VERSION_FULL}) - install (TARGETS ${_name} DESTINATION ${IGN_BIN_INSTALL_DIR}) + install (TARGETS ${_name} DESTINATION ${GZ_BIN_INSTALL_DIR}) manpage(${_name} 1) endmacro() @@ -1707,7 +1709,7 @@ endmacro() # [EXEC_LIST ] # [EXCLUDE_PROJECT_LIB]) # -# Build executables for an ignition project. Arguments are as follows: +# Build executables for an Gazebo project. Arguments are as follows: # # SOURCES: Required. The names (without a path) of the source files for your # executables. @@ -1801,7 +1803,7 @@ endmacro() # [INCLUDE_DIRS ] # [TEST_LIST ]) # -# Build tests for an ignition project. Arguments are as follows: +# Build tests for a Gazebo project. Arguments are as follows: # # TYPE: Required. Preferably UNIT, INTEGRATION, PERFORMANCE, or REGRESSION. # @@ -1929,7 +1931,7 @@ macro(gz_build_tests) if(Python3_Interpreter_FOUND) # Check that the test produced a result and create a failure if it didn't. # Guards against crashed and timed out tests. - add_test(check_${target_name} ${Python3_EXECUTABLE} ${IGNITION_CMAKE_TOOLS_DIR}/check_test_ran.py + add_test(check_${target_name} ${Python3_EXECUTABLE} ${GZ_CMAKE_TOOLS_DIR}/check_test_ran.py ${CMAKE_BINARY_DIR}/test_results/${target_name}.xml) endif() endforeach() @@ -1949,7 +1951,7 @@ endmacro() # This should also match the name of the function or macro that called it. # # NOTE: This should only be used by functions inside of gz-cmake specifically. -# Other ignition projects should not use this macro. +# Other Gazebo projects should not use this macro. # macro(_gz_cmake_parse_arguments prefix options oneValueArgs multiValueArgs) @@ -1964,7 +1966,7 @@ macro(_gz_cmake_parse_arguments prefix options oneValueArgs multiValueArgs) "\nThe build script has specified some unrecognized arguments for ${prefix}(~):\n" "${${prefix}_UNPARSED_ARGUMENTS}\n" "Either the script has a typo, or it is using an unexpected version of gz-cmake. " - "The version of gz-cmake currently being used is ${gz-cmake${IGNITION_CMAKE_VERSION_MAJOR}_VERSION}\n") + "The version of gz-cmake currently being used is ${gz-cmake${GZ_CMAKE_VERSION_MAJOR}_VERSION}\n") endif() diff --git a/cmake/cpack_options.cmake.in b/cmake/cpack_options.cmake.in index 22ba9dee..198c39af 100644 --- a/cmake/cpack_options.cmake.in +++ b/cmake/cpack_options.cmake.in @@ -1,7 +1,7 @@ set(CPACK_PACKAGE_NAME "@PROJECT_NAME_NO_VERSION@") set(CPACK_PACKAGE_VENDOR "osrfoundation.org") set(CPACK_PACKAGE_DESCRIPTION_SUMMARY - "A set of @IGN_DESIGNATION@ classes for robot applications.") + "A set of @GZ_DESIGNATION@ classes for robot applications.") set(CPACK_PACKAGE_INSTALL_DIRECTORY "@PROJECT_NAME_NO_VERSION_LOWER@") set(CPACK_RESOURCE_FILE_LICENSE "@CMAKE_CURRENT_SOURCE_DIR@/LICENSE") set(CPACK_RESOURCE_FILE_README "@CMAKE_CURRENT_SOURCE_DIR@/README.md") @@ -15,12 +15,12 @@ set(CPACK_DEBIAN_PACKAGE_SECTION "devel") set(CPACK_DEBIAN_PACKAGE_PRIORITY "optional") set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS ON) set(CPACK_DEBIAN_PACKAGE_DESCRIPTION - "A set of @IGN_DESIGNATION@ classes for robot applications.") + "A set of @GZ_DESIGNATION@ classes for robot applications.") set(CPACK_RPM_PACKAGE_ARCHITECTURE "@DPKG_ARCH@") set(CPACK_RPM_PACKAGE_REQUIRES "@DEBIAN_PACKAGE_DEPENDS@") set(CPACK_RPM_PACKAGE_DESCRIPTION - "A set of @IGN_DESIGNATION@ classes for robot applications.") + "A set of @GZ_DESIGNATION@ classes for robot applications.") set (CPACK_PACKAGE_FILE_NAME "@PROJECT_NAME_NO_VERSION_LOWER@-@PROJECT_VERSION_FULL@") diff --git a/cmake/gz-component-config.cmake.in b/cmake/gz-component-config.cmake.in index a1e1dd4e..0df01b56 100644 --- a/cmake/gz-component-config.cmake.in +++ b/cmake/gz-component-config.cmake.in @@ -47,7 +47,7 @@ include(CMakeFindDependencyMacro) # Find gz-cmake, because we need its modules in order to find the rest of # our dependencies. -find_dependency(gz-cmake@IGNITION_CMAKE_VERSION_MAJOR@) +find_dependency(gz-cmake@GZ_CMAKE_VERSION_MAJOR@) # Set the REQUIRED flag for the find_package(~) calls on this component's # dependencies. @@ -110,5 +110,5 @@ endif() set(@component_pkg_name@_LIBRARY @import_target_name@) # This macro is used by gz-cmake to automatically configure the pkgconfig -# files for ignition projects. +# files for Gazebo projects. gz_pkg_config_entry(@component_pkg_name@ "@component_pkg_name@") diff --git a/cmake/gz-config.cmake.in b/cmake/gz-config.cmake.in index 279cdfe6..9ee2642f 100644 --- a/cmake/gz-config.cmake.in +++ b/cmake/gz-config.cmake.in @@ -60,7 +60,7 @@ set(@PKG_NAME@_CONFIG_INCLUDED TRUE) include(CMakeFindDependencyMacro) # Find gz-cmake, because we need its modules in order to find the rest of # our dependencies. -find_dependency(gz-cmake@IGNITION_CMAKE_VERSION_MAJOR@) +find_dependency(gz-cmake@GZ_CMAKE_VERSION_MAJOR@) # Set the REQUIRED flag for the find_package(~) calls on this project's # dependencies. @@ -137,14 +137,14 @@ endif() # contain imported targets, so @PKG_NAME@_INCLUDE_DIRS is never needed. set(@PKG_NAME@_CORE_LIBRARY @simple_import_name@) set(@PKG_NAME@_LIBRARIES @gz_namespace@requested) -set_and_check(@PKG_NAME@_INCLUDE_DIRS "@PACKAGE_IGN_INCLUDE_INSTALL_DIR_FULL@") +set_and_check(@PKG_NAME@_INCLUDE_DIRS "@PACKAGE_GZ_INCLUDE_INSTALL_DIR_FULL@") # Backwards compatibility variables set(@LEGACY_PROJECT_PREFIX@_LIBRARIES ${@PKG_NAME@_LIBRARIES}) set(@LEGACY_PROJECT_PREFIX@_INCLUDE_DIRS ${@PKG_NAME@_INCLUDE_DIRS}) # This macro is used by gz-cmake to automatically configure the pkgconfig -# files for ignition projects. +# files for Gazebo projects. gz_pkg_config_entry(@PKG_NAME@ "@PKG_NAME@") # Find each of the components requested by find_package(~) @@ -173,7 +173,7 @@ foreach(component ${@PKG_NAME@_FIND_COMPONENTS}) endforeach() # Specify the doxygen tag file -set(@PROJECT_NAME_NO_VERSION_UPPER@_DOXYGEN_TAGFILE "${PACKAGE_PREFIX_DIR}/@IGN_DATA_INSTALL_DIR@/@PROJECT_NAME_LOWER@.tag.xml") +set(@PROJECT_NAME_NO_VERSION_UPPER@_DOXYGEN_TAGFILE "${PACKAGE_PREFIX_DIR}/@GZ_DATA_INSTALL_DIR@/@PROJECT_NAME_LOWER@.tag.xml") # Specify the API url. This is where the doxygen tag file will resolve URLS to. -set(@PROJECT_NAME_NO_VERSION_UPPER@_API_URL "https://gazebosim.org/api/@IGN_DESIGNATION@/@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@") +set(@PROJECT_NAME_NO_VERSION_UPPER@_API_URL "https://gazebosim.org/api/@GZ_DESIGNATION@/@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@") diff --git a/cmake/gz_auto_headers.hh.in b/cmake/gz_auto_headers.hh.in index 20c91f44..812a94c9 100644 --- a/cmake/gz_auto_headers.hh.in +++ b/cmake/gz_auto_headers.hh.in @@ -20,4 +20,4 @@ // made to cmake/gz_auto_headers.hh.in in gz-cmake #include <@PROJECT_INCLUDE_DIR@/config.hh> -${ign_headers} +${gz_headers} diff --git a/cmake/pkgconfig/gz-component.pc.in b/cmake/pkgconfig/gz-component.pc.in index 2a04c6a3..8eb522ef 100644 --- a/cmake/pkgconfig/gz-component.pc.in +++ b/cmake/pkgconfig/gz-component.pc.in @@ -1,9 +1,9 @@ prefix=${pcfiledir}/@PC_CONFIG_RELATIVE_PATH_TO_PREFIX@ libdir=${prefix}/@CMAKE_INSTALL_LIBDIR@ -includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@/@IGN_INCLUDE_INSTALL_DIR_POSTFIX@ +includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@/@GZ_INCLUDE_INSTALL_DIR_POSTFIX@ -Name: Gazebo @IGN_DESIGNATION@ @component_name@ -Description: A set of @IGN_DESIGNATION@ @component_name@ classes for robot applications +Name: Gazebo @GZ_DESIGNATION@ @component_name@ +Description: A set of @GZ_DESIGNATION@ @component_name@ classes for robot applications Version: @PROJECT_VERSION_FULL_NO_SUFFIX@ Requires: @component_pkgconfig_requires@ Requires.private: @component_pkgconfig_requires_private@ diff --git a/cmake/pkgconfig/gz.pc.in b/cmake/pkgconfig/gz.pc.in index 18da543d..95ab02ed 100644 --- a/cmake/pkgconfig/gz.pc.in +++ b/cmake/pkgconfig/gz.pc.in @@ -1,11 +1,11 @@ prefix=${pcfiledir}/@PC_CONFIG_RELATIVE_PATH_TO_PREFIX@ libdir=${prefix}/@CMAKE_INSTALL_LIBDIR@ -includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@/@IGN_INCLUDE_INSTALL_DIR_POSTFIX@ +includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@/@GZ_INCLUDE_INSTALL_DIR_POSTFIX@ -Name: Gazebo @IGN_DESIGNATION@ -Description: A set of @IGN_DESIGNATION@ classes for robot applications +Name: Gazebo @GZ_DESIGNATION@ +Description: A set of @GZ_DESIGNATION@ classes for robot applications Version: @PROJECT_VERSION_FULL_NO_SUFFIX@ -Requires: gz-cmake@IGNITION_CMAKE_VERSION_MAJOR@ >= 1.1 @PROJECT_PKGCONFIG_REQUIRES@ +Requires: gz-cmake@GZ_CMAKE_VERSION_MAJOR@ >= 1.1 @PROJECT_PKGCONFIG_REQUIRES@ Requires.private: @PROJECT_PKGCONFIG_REQUIRES_PRIVATE@ Libs: -L${libdir} @project_pkgconfig_core_lib@ @PROJECT_PKGCONFIG_LIBS@ Libs.private: @PROJECT_PKGCONFIG_LIBS_PRIVATE@ diff --git a/cmake/upload_doc.sh.in b/cmake/upload_doc.sh.in index d224c28d..b6bc2eab 100644 --- a/cmake/upload_doc.sh.in +++ b/cmake/upload_doc.sh.in @@ -20,7 +20,7 @@ if [ ! -f "@CMAKE_BINARY_DIR@/doxygen/html/index.html" ]; then fi # Dry run -aws s3 sync --dryrun @CMAKE_BINARY_DIR@/doxygen/html/ s3://gazebosim.org/api/@IGN_DESIGNATION@/@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@/ +aws s3 sync --dryrun @CMAKE_BINARY_DIR@/doxygen/html/ s3://gazebosim.org/api/@GZ_DESIGNATION@/@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@/ if [ -z "$1" ]; then echo -n "Upload (Y/n)? " @@ -32,7 +32,7 @@ fi if [ "$ans" = "n" ] || [ "$ans" = "N" ]; then exit 1 else - aws s3 sync @CMAKE_BINARY_DIR@/doxygen/html/ s3://gazebosim.org/api/@IGN_DESIGNATION@/@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@/ + aws s3 sync @CMAKE_BINARY_DIR@/doxygen/html/ s3://gazebosim.org/api/@GZ_DESIGNATION@/@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@/ echo "WARNING" echo " A CloudFront invalidation is required. Run the following command with the appropriate \$CLOUDFRONT_DISTRIBUTION_ID:\n" diff --git a/cmake/version_info.json.in b/cmake/version_info.json.in index 6afd1c65..30025005 100644 --- a/cmake/version_info.json.in +++ b/cmake/version_info.json.in @@ -37,6 +37,15 @@ "revision_number": "${HG_REVISION_NUM}", "branch": "${HG_BRANCH}" }, + "gz": + { + "project_name": "${PROJECT_NAME}", + "version": "${PROJECT_VERSION}", + "version_full": "${PROJECT_VERSION_FULL}", + "major": "${PROJECT_VERSION_MAJOR}", + "minor": "${PROJECT_VERSION_MINOR}", + "patch": "${PROJECT_VERSION_PATCH}" + }, "ignition": { "project_name": "${PROJECT_NAME}", @@ -47,4 +56,3 @@ "patch": "${PROJECT_VERSION_PATCH}" } } - diff --git a/codecheck/cpplint.py b/codecheck/cpplint.py index 1632bed1..a080437d 100644 --- a/codecheck/cpplint.py +++ b/codecheck/cpplint.py @@ -6669,7 +6669,7 @@ def ProcessFile(filename, vlevel, extra_check_functions=None): # should rely on the extension. if filename != '-' and file_extension not in GetAllExtensions(): pass - # Ignition: never print this + # Gazebo: never print this # _cpplint_state.PrintError('Ignoring %s; not a valid file name ' # '(%s)\n' % (filename, ', '.join(GetAllExtensions()))) else: @@ -6698,7 +6698,7 @@ def ProcessFile(filename, vlevel, extra_check_functions=None): # count has increased after processing this file. if not _cpplint_state.quiet or old_errors != _cpplint_state.error_count: pass - # Ignition: never print "Done Processing" + # Gazebo: never print "Done Processing" # _cpplint_state.PrintInfo('Done processing %s\n' % filename) _RestoreFilters() diff --git a/config/gz-cmake-config.cmake.in b/config/gz-cmake-config.cmake.in index 48ce9e56..4e8a02dd 100644 --- a/config/gz-cmake-config.cmake.in +++ b/config/gz-cmake-config.cmake.in @@ -22,13 +22,13 @@ set(@PKG_NAME@_CONFIG_INCLUDED TRUE) @PACKAGE_INIT@ -if(NOT TARGET @ign_utilities_import_target_name@) - include("${CMAKE_CURRENT_LIST_DIR}/@ign_utilities_target_output_filename@") +if(NOT TARGET @gz_utilities_import_target_name@) + include("${CMAKE_CURRENT_LIST_DIR}/@gz_utilities_target_output_filename@") # Create a simplified imported target name for the utilities library add_library(@simple_utilities_import_name@ INTERFACE IMPORTED) set_target_properties(@simple_utilities_import_name@ PROPERTIES - INTERFACE_LINK_LIBRARIES @ign_utilities_import_target_name@) + INTERFACE_LINK_LIBRARIES @gz_utilities_import_target_name@) endif() @@ -41,31 +41,37 @@ endif() # gz-cmake. All find-modules that are available in older versions of gz-cmake # should be available in newer versions of gz-cmake, so this should not create # any conflicts. -if( NOT IGNITION_CMAKE_VERSION_MAJOR - OR (IGNITION_CMAKE_VERSION_MAJOR LESS @PROJECT_VERSION_MAJOR@) ) +if( NOT GZ_CMAKE_VERSION_MAJOR + OR (GZ_CMAKE_VERSION_MAJOR LESS @PROJECT_VERSION_MAJOR@) ) #-------------------------------------- # Create a variable to indicate what version of gz-cmake we are using. # This variable does not follow the usual cmake naming convention because it # is a non-standard package variable. - set(IGNITION_CMAKE_VERSION_MAJOR @PROJECT_VERSION_MAJOR@) + set(GZ_CMAKE_VERSION_MAJOR @PROJECT_VERSION_MAJOR@) + set(IGNITION_CMAKE_VERSION_MAJOR ${GZ_CMAKE_VERSION_MAJOR}) # TODO(CH3): Deprecated. Remove on tock. #-------------------------------------- - # Initialize the IGNITION_CMAKE_DIR variable with the location of the cmake + # Initialize the GZ_CMAKE_DIR variable with the location of the cmake # directory that sits next to this find-module. - set(IGNITION_CMAKE_DIR "${CMAKE_CURRENT_LIST_DIR}/cmake@PROJECT_VERSION_MAJOR@") + set(GZ_CMAKE_DIR "${CMAKE_CURRENT_LIST_DIR}/cmake@PROJECT_VERSION_MAJOR@") #-------------------------------------- # Add the location of this package's cmake directory to the CMAKE_MODULE_PATH - list(APPEND CMAKE_MODULE_PATH "${IGNITION_CMAKE_DIR}") + list(APPEND CMAKE_MODULE_PATH "${GZ_CMAKE_DIR}") #-------------------------------------- - # include the master IgnCMake module + # include the master GzCMake module include(GzCMake) - set(IGNITION_CMAKE_DOXYGEN_DIR "@PACKAGE_IGN_DATA_INSTALL_DIR@/doxygen") - set(IGNITION_CMAKE_CODECHECK_DIR "@PACKAGE_IGN_DATA_INSTALL_DIR@/codecheck") - set(IGNITION_CMAKE_BENCHMARK_DIR "@PACKAGE_IGN_DATA_INSTALL_DIR@/benchmark") - set(IGNITION_CMAKE_TOOLS_DIR "@PACKAGE_IGN_DATA_INSTALL_DIR@/tools") + set(GZ_CMAKE_DOXYGEN_DIR "@PACKAGE_GZ_DATA_INSTALL_DIR@/doxygen") + set(GZ_CMAKE_CODECHECK_DIR "@PACKAGE_GZ_DATA_INSTALL_DIR@/codecheck") + set(GZ_CMAKE_BENCHMARK_DIR "@PACKAGE_GZ_DATA_INSTALL_DIR@/benchmark") + set(GZ_CMAKE_TOOLS_DIR "@PACKAGE_GZ_DATA_INSTALL_DIR@/tools") + + set(IGNITION_CMAKE_DOXYGEN_DIR ${GZ_CMAKE_DOXYGEN_DIR}) # TODO(CH3): Deprecated. Remove on tock. + set(IGNITION_CMAKE_CODECHECK_DIR ${GZ_CMAKE_CODECHECK_DIR}) # TODO(CH3): Deprecated. Remove on tock. + set(IGNITION_CMAKE_BENCHMARK_DIR ${GZ_CMAKE_BENCHMARK_DIR}) # TODO(CH3): Deprecated. Remove on tock. + set(IGNITION_CMAKE_TOOLS_DIR ${GZ_CMAKE_TOOLS_DIR}) # TODO(CH3): Deprecated. Remove on tock. endif() diff --git a/config/gz-cmake.pc.in b/config/gz-cmake.pc.in index b844ab84..2d458dab 100644 --- a/config/gz-cmake.pc.in +++ b/config/gz-cmake.pc.in @@ -1,7 +1,7 @@ -prefix=${pcfiledir}/@IGN_PC_CONFIG_RELATIVE_PATH_TO_PREFIX@ -includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@/@IGN_INCLUDE_INSTALL_DIR_POSTFIX@ +prefix=${pcfiledir}/@GZ_PC_CONFIG_RELATIVE_PATH_TO_PREFIX@ +includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@/@GZ_INCLUDE_INSTALL_DIR_POSTFIX@ -Name: Gazebo @IGN_DESIGNATION@ +Name: Gazebo @GZ_DESIGNATION@ Description: Build system package for the Gazebo libraries Version: @PROJECT_VERSION_FULL_NO_SUFFIX@ Requires: diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 9ca86b1a..f07604d0 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,3 +1,3 @@ install(DIRECTORY doxygen/ - DESTINATION ${IGN_DATA_INSTALL_DIR}/doxygen) + DESTINATION ${GZ_DATA_INSTALL_DIR}/doxygen) diff --git a/doc/doxygen/api.in b/doc/doxygen/api.in index a5ee5933..7d282acf 100644 --- a/doc/doxygen/api.in +++ b/doc/doxygen/api.in @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "Gazebo @IGN_DESIGNATION_CAP@" +PROJECT_NAME = "Gazebo @GZ_DESIGNATION_CAP@" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -693,7 +693,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = "@IGNITION_CMAKE_DOXYGEN_DIR@/layout.xml" +LAYOUT_FILE = "@GZ_CMAKE_DOXYGEN_DIR@/layout.xml" # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -768,7 +768,7 @@ WARN_FORMAT = "$file:$line: $text" # messages should be written. If left blank the output is written to standard # error (stderr). -WARN_LOGFILE = gazebo-doxygen.warn +WARN_LOGFILE = gz-doxygen.warn #--------------------------------------------------------------------------- # Configuration options related to the input files @@ -780,7 +780,7 @@ WARN_LOGFILE = gazebo-doxygen.warn # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = @IGNITION_DOXYGEN_INPUT@ +INPUT = @GZ_DOXYGEN_INPUT@ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -881,7 +881,7 @@ EXAMPLE_RECURSIVE = YES # that contain images that are to be included in the documentation (see the # \image command). -IMAGE_PATH = @IGNITION_DOXYGEN_IMAGE_PATH@ +IMAGE_PATH = @GZ_DOXYGEN_IMAGE_PATH@ # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program @@ -915,7 +915,7 @@ INPUT_FILTER = # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. -FILTER_PATTERNS = *.hh="sed -e 's/inline\snamespace\s.*\s{$\|gz::@IGN_DESIGNATION@::\|GZ_DEPRECATED([0-9\.]\+)\|GZ_@IGN_DESIGNATION_UPPER@_VISIBLE//g'" +FILTER_PATTERNS = *.hh="sed -e 's/inline\snamespace\s.*\s{$\|gz::@GZ_DESIGNATION@::\|GZ_DEPRECATED([0-9\.]\+)\|GZ_@GZ_DESIGNATION_UPPER@_VISIBLE//g'" # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for @@ -937,7 +937,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = @IGNITION_DOXYGEN_API_MAINPAGE_MD@ +USE_MDFILE_AS_MAINPAGE = @GZ_DOXYGEN_API_MAINPAGE_MD@ #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -1058,7 +1058,7 @@ IGNORE_PREFIX = # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. -GENERATE_HTML = @IGNITION_DOXYGEN_GENHTML@ +GENERATE_HTML = @GZ_DOXYGEN_GENHTML@ # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of @@ -1093,7 +1093,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = @IGNITION_CMAKE_DOXYGEN_DIR@/header.html +HTML_HEADER = @GZ_CMAKE_DOXYGEN_DIR@/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1103,7 +1103,7 @@ HTML_HEADER = @IGNITION_CMAKE_DOXYGEN_DIR@/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = @IGNITION_CMAKE_DOXYGEN_DIR@/footer.html +HTML_FOOTER = @GZ_CMAKE_DOXYGEN_DIR@/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1231,7 +1231,7 @@ GENERATE_DOCSET = NO # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. -DOCSET_FEEDNAME = "Gazebo @IGN_DESIGNATION_CAP@ API Documentation" +DOCSET_FEEDNAME = "Gazebo @GZ_DESIGNATION_CAP@ API Documentation" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. @@ -2081,13 +2081,13 @@ SKIP_FUNCTION_MACROS = NO # the path). If a tag file is not located in the directory in which doxygen is # run, you must also specify the path to the tagfile here. -TAGFILES = "@IGNITION_CMAKE_DOXYGEN_DIR@/cppreference.tag.xml = http://en.cppreference.com/w" @IGNITION_DOXYGEN_TAGFILES@ +TAGFILES = "@GZ_CMAKE_DOXYGEN_DIR@/cppreference.tag.xml = http://en.cppreference.com/w" @GZ_DOXYGEN_TAGFILES@ # When a file name is specified after GENERATE_TAGFILE, doxygen will create a # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. -GENERATE_TAGFILE = @IGNITION_DOXYGEN_GENTAGFILE@ +GENERATE_TAGFILE = @GZ_DOXYGEN_GENTAGFILE@ # If the ALLEXTERNALS tag is set to YES, all external class will be listed in # the class index. If set to NO, only the inherited external classes will be diff --git a/doc/doxygen/header.html b/doc/doxygen/header.html index e4fa1c9b..078476e9 100644 --- a/doc/doxygen/header.html +++ b/doc/doxygen/header.html @@ -47,8 +47,8 @@

API Reference

-