From: maier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Sun, 7 Apr 2013 21:37:20 +0000 (+0000)
Subject: Small documentation update
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=78e1b28c8d3fc0b6c8f8d70d47d1bd50a54d97cc;p=dealii-svn.git

Small documentation update

git-svn-id: https://svn.dealii.org/trunk@29215 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/cmake/setup_deal_ii.cmake b/deal.II/cmake/setup_deal_ii.cmake
index a7f8efe4f6..c77fa6d7b0 100644
--- a/deal.II/cmake/setup_deal_ii.cmake
+++ b/deal.II/cmake/setup_deal_ii.cmake
@@ -101,8 +101,8 @@ IF(DEAL_II_COMPONENT_COMPAT_FILES)
   #
   SET_IF_EMPTY(DEAL_II_CMAKE_MACROS_RELDIR "cmake/macros")
   SET_IF_EMPTY(DEAL_II_COMMON_RELDIR "common")
-  SET_IF_EMPTY(DEAL_II_DOCREADME_RELDIR "")
   SET_IF_EMPTY(DEAL_II_DOCHTML_RELDIR "doc")
+  SET_IF_EMPTY(DEAL_II_DOCREADME_RELDIR "")
   SET_IF_EMPTY(DEAL_II_EXAMPLES_RELDIR "examples")
   SET_IF_EMPTY(DEAL_II_EXECUTABLE_RELDIR "bin")
   IF( "${CMAKE_INSTALL_PREFIX}" STREQUAL "${CMAKE_BINARY_DIR}" AND
diff --git a/deal.II/doc/development/cmake.html b/deal.II/doc/development/cmake.html
index 33201002c5..e9e6643ea9 100644
--- a/deal.II/doc/development/cmake.html
+++ b/deal.II/doc/development/cmake.html
@@ -33,6 +33,7 @@
               <ul>
                 <li><a href="#operatingmanip">Manipulating the cache</a>
                 <li><a href="#operatingccmake"><code>ccmake</code> and special build targets </a>
+                <li><a href="#operatingshortcuts">Shortcuts</a>
               </ul>
 	    <li><a href="#configure">Configuration options</a>
 	      <ul>
@@ -130,6 +131,7 @@
     <a name="operatingmanip"></a>
     <h4> Manipulating the cache </h4>
 
+    <p>
       A cached variable can be set on the command line via
       <pre>
 
@@ -148,10 +150,12 @@
 
     cmake -U"DEAL_II_WITH_*" .
       </pre>
+    </p>
 
     <a name="operatingccmake"></a>
     <h4> <code>ccmake</code> and special build targets </h4>
 
+    <p>
       A very convenient way to alter the configuration is to use the graphical
       user interface <code>ccmake</code> to the
       variables <code>cmake</code> stores upon running. It can be invoked via
@@ -170,6 +174,29 @@
 
     make rebuild_cache
       </pre>
+    </p>
+
+    <a name="operatingshortcuts"></a>
+    <h4> Shortcuts </h4>
+
+    <p>
+      All variables starting with <code>WITH_</code> will be automatically
+      renamed to <code>DEAL_II_WITH_*</code>. So, it suffices to specify
+    <pre>
+
+    cmake -DWITH_MPI=ON &lt;...&gt;
+    </pre>
+      instead of the longer
+    <pre>
+
+    cmake -DDEAL_II_WITH_MPI=ON &lt;...&gt;
+    </pre>
+      The same holds for all variables starting with <code>COMPONENT_</code>
+      and all individual component names: <code>COMPAT_FILES</code>,
+      <code>DOCUMENTATION</code>, <code>EXAMPLES</code>,
+      <code>MESH_CONVERTER</code> and <code>PARAMETER_GUI</code> (which
+      will be expanded to the full <code>DEAL_II_COMPONENT_*</code> variable name).
+    </p>
 
     <a name="configure"></a>
     <h3>Configuration options</h3>
@@ -658,7 +685,7 @@
         lib${LIB_SUFFIX}/cmake/deal.II
         share/deal.II/
         share/deal.II/cmake/macros
-        share/doc/deal.II/examples
+        share/deal.II/examples
         share/doc/deal.II/html
 	  </pre>
       </ul>
@@ -670,6 +697,7 @@
       <pre>
 
     DEAL_II_CMAKE_MACROS_RELDIR
+    DEAL_II_COMMON_RELDIR
     DEAL_II_DOCHTML_RELDIR
     DEAL_II_DOCREADME_RELDIR
     DEAL_II_EXAMPLES_RELDIR