<p>
This page provides details about the CMake build system. Files
processed by the top level <code>CMakeLists.txt</code> script are
- listed in the TOC in cronological order.
+ listed in the TOC in chronological order.
</p>
<p>
)
</pre>
CMake operates almost always with variables in global state. To guard
- against accidential overwrite of variables the following naming
+ against accidental overwrite of variables the following naming
conventions must be followed at all times:
<ul>
<li>
<pre>
CHECK_CXX_SOURCE_COMPILES(source variable)
- - Checks whether it is possible to compile _and_ link the code snipet
- <source>. If succesful, variable is set to 1.
+ - Checks whether it is possible to compile _and_ link the code snippet
+ <source>. If successful, variable is set to 1.
CHECK_CXX_SOURCE_RUNS(source variable)
- - variable is set to 1 if <source> coulde be succesfully compiled and
+ - variable is set to 1 if <source> could be successfully compiled and
linked and the resulting program ran and exited without error.
Avoid this macro outside of a DEAL_II_ALLOW_PLATFORM_INTROSPECTION
guard. A sensible fallback should be provided if the check cannot
<li> Necessary include directories and libraries necessary for
linkage can be set in the list variables
<code>CMAKE_REQUIRED_INCLUDES</code> and
- <code>CMAKE_REQUIRED_LIBRARIES</code>. It is best ot append these
+ <code>CMAKE_REQUIRED_LIBRARIES</code>. It is best to append these
lists and later on reset <code>CMAKE_REQUIRED_*</code> (including
<code>CMAKE_REQUIRED_FLAGS</code>) to their default values:
<pre>
FEATURE_<FEATURE>_DEPENDS (a variable)
- a variable which contains an optional list of other features
- this feature depends on (and which have to be enbled for this feature
+ this feature depends on (and which have to be enabled for this feature
to work.) The features must be given with the full option toggle:
DEAL_II_WITH_[...]
# Glob for all header files associated with the object target:
# As this list is only for cosmetic reasons, so that associated header
# files show up in IDEs, we don't manage an explicit list (with the
- # tradeoff to have to run "make rebuild_cache" when a new header file
+ # trade-off to have to run "make rebuild_cache" when a new header file
# emerges...)
#
FILE(GLOB _header
</pre>
switches off support for the METIS library that may have been
automatically detected during the first invocation of
- <code>cmake</code> and enables support for Trilinos by enablind
+ <code>cmake</code> and enables support for Trilinos by enabling
<code>DEAL_II_WITH_TRILINOS</code> and setting
<code>TRILINOS_DIR</code>.
</p>
Alternatively, cached variables set by the
<code>Find<Module></code> mechanism may be set,
hinted or overwritten directly (variable names are highly
- dependend on the actual library). You can get a list via
+ dependent on the actual library). You can get a list via
<pre>
make edit_cache
<ul>
<li>
The compiler <i>must</i> be specified at the very first
- invokation of <code>cmake</code>.
+ invocation of <code>cmake</code>.
<li>
A working CXX compiler is needed. It is optional to provide a C
or Fortran compiler.