From dfd23c4bf5c5fc830447c4a88b66a5f68cd2d63a Mon Sep 17 00:00:00 2001
From: Dominic Kempf <dominic.r.kempf@gmail.com>
Date: Thu, 15 Oct 2015 13:03:23 +0200
Subject: [PATCH] Fix some warnings in the building of the sphinx docs
---
cmake/modules/DuneMacros.cmake | 11 +++++++++++
doc/buildsystem/dune-common.rst | 13 ++++---------
2 files changed, 15 insertions(+), 9 deletions(-)
diff --git a/cmake/modules/DuneMacros.cmake b/cmake/modules/DuneMacros.cmake
index b1b1843c1..a2c55b011 100644
--- a/cmake/modules/DuneMacros.cmake
+++ b/cmake/modules/DuneMacros.cmake
@@ -65,6 +65,17 @@
# library BASENAME
#
#
+# .. cmake_function:: add_dune_all_flags
+#
+# .. cmake_param:: targets
+# :single:
+# :required:
+# :positional:
+#
+# The targets to add the flags of all external libraries to.
+#
+# This function is superseded by :ref:`dune_target_enable_all_packages`.
+#
# Documentation of internal macros in this module:
#
# dune_module_to_uppercase(upper_name module_name)
diff --git a/doc/buildsystem/dune-common.rst b/doc/buildsystem/dune-common.rst
index 189390fd9..3153030a0 100644
--- a/doc/buildsystem/dune-common.rst
+++ b/doc/buildsystem/dune-common.rst
@@ -7,7 +7,7 @@ CMake...
- is an open source buildsystem tool developed at KITware.
- offers a one-tool-solution to all building tasks, like configuring, building, linking, testing and packaging.
-- is a build system generator: It supports a set of backends called ``generators''
+- is a build system generator: It supports a set of backends called *generators*
- is portable
- is controlled by ONE rather simple language
@@ -19,6 +19,7 @@ You can install cmake through your favorite package manager or downloading sourc
The minimum required version to build Dune with CMake is 2.8.6.
.. _howtouse:
+
How do I use Dune with CMake?
=============================
@@ -65,7 +66,7 @@ How do I port an existing module?
There is multiple approaches to this:
-- First, check :ref:`enable` and decide whether such simple approach is sufficient for your project.
+- First, check :ref:`simplified` and decide whether such simple approach is sufficient for your project.
- There is the python script :code:`dune-common/bin/am2cmake.py`, which automatically generates :code:`CMakeLists.txt`'s
from its :code:`Makefile.am` counterparts. While this works fine, for many modules the resulting files look very
autotoolish and are often too complicated.
@@ -163,8 +164,6 @@ your source tree's structure as seen in the following. Assume the following sour
src/
CMakeLists.txt
-::
-
The generated build directory will have the following structure, where the directory :code:`build-cmake`
is a subdirectory of the source directory:
@@ -178,8 +177,6 @@ is a subdirectory of the source directory:
src/
Makefile
-::
-
Using the :code:`Unix Makefiles` generator, your Makefiles are generated in the build tree, so that is where you
have to call :code:`make`. There are multiple advantages with this approach, such as a clear separation between
version controlled and generated files and you can have multiple out-of-source builds with different configurations
@@ -199,8 +196,6 @@ the :code:`--builddir` option, you will get something like this:
dune-foo/
Makefile
-::
-
So, instead of one build directory in every dune module, you will be able to collect all build directories in one
directory. This makes it much easier to have multiple build directories and to remove build directories.
@@ -337,7 +332,7 @@ Why is it not possible anymore to do make headercheck?
======================================================
The headercheck feature has been disabled by default. You can enable it by setting the CMake variable :ref:`ENABLE_HEADERCHECK`
- through your opts file. This step has been necessary, because of the large amount of additional file the headercheck adds to the
+through your opts file. This step has been necessary, because of the large amount of additional file the headercheck adds to the
build directory. A better implementation has not been found yet, because it simply does not fit the CMake philosophy.
.. _troubleshoot:
--
GitLab