Skip to content

Commit

Permalink
update macro name, add doc line about multiple invocations
Browse files Browse the repository at this point in the history
Signed-off-by: Dirk Thomas <dirk-thomas@users.noreply.github.com>
  • Loading branch information
dirk-thomas committed Oct 17, 2019
1 parent 112d8d1 commit b87b4e6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion ament_cmake_version/ament_cmake_version-extras.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@
find_package(ament_cmake_core QUIET REQUIRED)

include(
"${ament_cmake_version_DIR}/ament_bump_development_version_if_necessary.cmake")
"${ament_cmake_version_DIR}/ament_export_development_version_if_higher_than_manifest.cmake")
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@
# limitations under the License.

#
# Bump the exported package version to the passed version if the package
# Set the exported package version to the passed value if the package
# version in the manifest is lower.
#
# It is recommended to append the suffix ``-dev`` to the passed upcoming
# version number.
# If the package version in the manifest is equal or newer than the passed
# development version this function call becomes a no-op.
# If the function is called multiple times only the higher version number will
# be used.
#
# .. note:: It is indirectly calling``ament_package_xml()`` if that hasn't
# happened already.
Expand All @@ -29,15 +31,15 @@
#
# @public
#
macro(ament_bump_development_version_if_necessary development_version)
macro(ament_export_development_version_if_higher_than_manifest development_version)
if(ARGN)
message(FATAL_ERROR
"ament_bump_development_version_if_necessary() called with unused arguments: ${ARGN}")
"ament_export_development_version_if_higher_than_manifest() called with unused arguments: ${ARGN}")
endif()

if(DEFINED _${PROJECT_NAME}_AMENT_PACKAGE)
message(FATAL_ERROR
"ament_bump_development_version_if_necessary() must be called before "
"ament_export_development_version_if_higher_than_manifest() must be called before "
"ament_package()")
endif()

Expand Down

0 comments on commit b87b4e6

Please sign in to comment.