Skip to content

Commit

Permalink
update doc on CFG_EXTRAS (#353)
Browse files Browse the repository at this point in the history
  • Loading branch information
dirk-thomas committed Feb 12, 2013
1 parent 0cea0c8 commit d2f3ef7
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions cmake/catkin_package.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,15 @@
# :param CFG_EXTRAS: a CMake file containing extra stuff that should
# be accessible to users of this package after
# ``find_package``\ -ing it. This file must live in the
# subdirectory ``cmake`` and must have the additional extension
# ``.in`` (since it is expanded using CMake's ``configure_file()``).
# The template can distinguish between build- and installspace
# using the boolean variables ``DEVELSPACE`` and ``INSTALLSPACE``
# and should be verified to work in both cases.
# subdirectory ``cmake``. Various additional extension are possible:
# for a plain cmake file just ``.cmake``, for files expanded using
# CMake's ``configure_file()`` use ``.cmake.in`` or for files expanded
# by empy use ``.cmake.em``. The templates can distinguish between
# devel- and installspace using the boolean variables ``DEVELSPACE``
# and ``INSTALLSPACE``. For em templated files it is also possible to
# use the extensions ``.cmake.develspace.em`` or
# ``.cmake.installspace.em`` to generate the files only for a specific
# case.
# :type CFG_EXTRAS: string
#
# Example:
Expand All @@ -51,7 +55,7 @@
# LIBRARIES projlib1 projlib2
# CATKIN-DEPENDS roscpp
# DEPENDS Eigen
# CFG_EXTRAS proj-extras.cmake
# CFG_EXTRAS proj-extras[.cmake|.cmake.in|.cmake(.develspace|.installspace)?.em]
# )
#
# @public
Expand Down

0 comments on commit d2f3ef7

Please sign in to comment.