.. _dune_symlink_to_source_tree:

dune_symlink_to_source_tree
===========================

.. cmake_function:: dune_symlink_to_source_tree

   .. cmake_param:: NAME
      :single:

      The name of the symlink, defaults to :code:`src_dir`.

   This function will place a symlink into every subdirectory
   of the build tree, that allows to jump to the corresponding
   source directory. Call this from your top-level :code:`CMakeLists.txt`
   to enable it for a given module. To enable it for all modules,
   set the variable :ref:`DUNE_SYMLINK_TO_SOURCE_TREE` instead.
   If used on Windows systems, a warning is issued.

