aboutsummaryrefslogtreecommitdiff
path: root/manifest-reference.md
diff options
context:
space:
mode:
authorJakub JelĂ­nek <33724536+kubajj@users.noreply.github.com>2021-03-26 23:37:39 +0100
committerGitHub <noreply@github.com>2021-03-26 23:37:39 +0100
commite70ce36a74cfd6d29c552140bc979377881147f6 (patch)
tree8e91212f1115aedf90db865a240f4d4060e0ce93 /manifest-reference.md
parent9a14cd1e10a26f527fde7fedb94109c6b46a262a (diff)
parentcb3337b021c5e590c34ec5e0b65b45cc7d497122 (diff)
downloadfpm-e70ce36a74cfd6d29c552140bc979377881147f6.tar.gz
fpm-e70ce36a74cfd6d29c552140bc979377881147f6.zip
Merge branch 'master' into Duplicate_module_definitions
Diffstat (limited to 'manifest-reference.md')
-rw-r--r--manifest-reference.md24
1 files changed, 21 insertions, 3 deletions
diff --git a/manifest-reference.md b/manifest-reference.md
index 8e9f65d..b40eef8 100644
--- a/manifest-reference.md
+++ b/manifest-reference.md
@@ -188,17 +188,35 @@ Library targets are exported and useable for other projects.
### Library configuration
Defines the exported library target of the project.
-A library is generated if the source directory is found in a project.
-The default source directory is ``src`` but can be modified in the *library* section using the *source-dir* entry.
-Paths for the source directory are given relative to the project root and use ``/`` as path separator on all platforms.
+A library is generated if the source directory or include directory is found in a project.
+The default source and include directories are ``src`` and ``include``; these can be modified in the *library* section using the *source-dir* and *include-dir* entries.
+Paths for the source and include directories are given relative to the project root and use ``/`` as path separator on all platforms.
*Example:*
```toml
[library]
source-dir = "lib"
+include-dir = "inc"
+```
+
+#### Include directory
+
+> Supported in Fortran fpm only
+
+Projects which use the Fortran `include` statement or C preprocessor `#include` statement, can use the *include-dir* key to specify search directories for the included files.
+*include-dir* can contain one or more directories, where multiple directories are specified using a list of strings.
+Include directories from all project dependencies are passed to the compiler using the appropriate compiler flag.
+
+*Example:*
+
+```toml
+[library]
+include-dir = ["include", "third_party/include"]
```
+> *include-dir* does not currently allow using pre-built module `.mod` files
+
#### Custom build script
> Supported in Bootstrap fpm only