Include directive sorter
[alexxy/gromacs.git] / docs / doxygen / codelayout.md
index 24bb7ae0c5737ef0b47599658dbc5ebe7f78556f..727f978c4371324d5a477c56006706d451695abc 100644 (file)
@@ -68,7 +68,7 @@ See \ref page_unittesting for more details.
 \endif
 
 When compiling, the include search path is set to `src/`.  This means that
-source files include headers as
+files include headers as
 
     #include "gromacs/<module>/<file>.h"
 
@@ -76,23 +76,12 @@ The following is also possible for intra-module headers:
 
     #include "<file>.h"
 
-Header files include other headers using
-
-    #include "../<othermodule>/<file>.h"
-
-because relative paths work best for installed headers.  For non-installed
-headers, the path relative to `src/` is sometimes also used.
-
 For historical reasons, there are directories `src/gromacs/gmxana/`,
 `src/gromacs/gmxlib/`, `src/gromacs/mdlib/`, and `src/gromacs/gmxpreprocess/`
 that do not follow the above rules.  The installed headers for these are in
 `src/gromacs/legacyheaders/`.  The aim is to gradually get rid of these
 directories and move code into proper modules.
 
-For similar historical reasons, the include path also includes
-`src/gromacs/legacyheaders/`.  It is preferred that new code does not depend on
-this.
-
 Documentation organization
 ==========================