diff options
| author | Brad King <brad.king@kitware.com> | 2014-05-27 16:33:37 -0400 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2014-05-27 16:40:40 -0400 |
| commit | f49b6a33f6c4920bf9f18735f66d91c51c2f1581 (patch) | |
| tree | 1ce02b33524cce55c99fb15e0185622f9fd37766 /Modules/FindDoxygen.cmake | |
| parent | 7980eab8d5df63db4077fd1121c6cbe860146ad1 (diff) | |
| download | cmake-f49b6a33f6c4920bf9f18735f66d91c51c2f1581.tar.gz | |
FindDoxygen: Deprecate DOXYGEN_DOT_PATH
While at it, do not cache the value since it should always be
computed directly from DOXYGEN_DOT_EXECUTABLE.
Inspired-by: Lars Bilke <larsbilke83@googlemail.com>
Diffstat (limited to 'Modules/FindDoxygen.cmake')
| -rw-r--r-- | Modules/FindDoxygen.cmake | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/Modules/FindDoxygen.cmake b/Modules/FindDoxygen.cmake index 844699ed86..d34941aa2c 100644 --- a/Modules/FindDoxygen.cmake +++ b/Modules/FindDoxygen.cmake @@ -30,7 +30,16 @@ # # DOXYGEN_DOT_EXECUTABLE = The path to the dot program used by doxygen. # DOXYGEN_DOT_FOUND = Was Dot found or not? -# DOXYGEN_DOT_PATH = The path to dot not including the executable +# +# For compatibility with older versions of CMake, the now-deprecated +# variable ``DOXYGEN_DOT_PATH`` is set to the path to the directory +# containing ``dot`` as reported in ``DOXYGEN_DOT_EXECUTABLE``. +# The path may have forward slashes even on Windows and is not +# suitable for direct substitution into a ``Doxyfile.in`` template. +# If you need this value, use :command:`get_filename_component` +# to compute it from ``DOXYGEN_DOT_EXECUTABLE`` directly, and +# perhaps the :command:`file(TO_NATIVE_PATH)` command to prepare +# the path for a Doxygen configuration file. #============================================================================= # Copyright 2001-2009 Kitware, Inc. @@ -125,7 +134,7 @@ if(NOT DOXYGEN_SKIP_DOT) if(DOXYGEN_DOT_EXECUTABLE) set(DOXYGEN_DOT_FOUND TRUE) # The Doxyfile wants the path to Dot, not the entire path and executable - get_filename_component(DOXYGEN_DOT_PATH "${DOXYGEN_DOT_EXECUTABLE}" PATH CACHE) + get_filename_component(DOXYGEN_DOT_PATH "${DOXYGEN_DOT_EXECUTABLE}" PATH) endif() endif() @@ -159,5 +168,4 @@ set (DOT ${DOXYGEN_DOT_EXECUTABLE} ) mark_as_advanced( DOXYGEN_EXECUTABLE DOXYGEN_DOT_EXECUTABLE - DOXYGEN_DOT_PATH ) |