Mention gmx_install_headers() in the developer manual
authorAleksei Iupinov <a.yupinov@gmail.com>
Fri, 24 Nov 2017 10:55:16 +0000 (11:55 +0100)
committerMark Abraham <mark.j.abraham@gmail.com>
Fri, 24 Nov 2017 13:20:45 +0000 (14:20 +0100)
Change-Id: I703e63b7e8978f23963107044396331cbfe94d7e

docs/dev-manual/gmxtree.rst

index c942b6d99a26adae2dd6c8367e443b536c091b97..2fc13566cdab46decfece57f3c777de5757f0265 100644 (file)
@@ -85,7 +85,9 @@ module and documenting it.
 
         #include <...> // This should be used for system and external headers
 
-  * Installed headers must not include non-installed headers.
+  * Installed headers must not include non-installed headers. Headers can be
+    marked for install within ``CMakeLists.txt`` files of their respective
+    modules, using ``gmx_install_headers()``.
   * All source files must include "gmxpre.h" as the first header.
   * A source/header file should include "config.h," "gromacs/simd/simd.h",
     or "gromacs/ewald/pme-simd.h" if and only if it uses a macro declared