aboutsummaryrefslogtreecommitdiff
path: root/PACKAGING.md
diff options
context:
space:
mode:
authorBrad Richardson <brichardson@structint.com>2020-06-15 19:41:16 -0700
committerBrad Richardson <brichardson@structint.com>2020-06-15 19:41:16 -0700
commitdf531fcffdd5c7b6233d0107152725ce3f8f22c1 (patch)
tree58f186a47143392564cae718abb9017293e5e3d4 /PACKAGING.md
parentec8855dc7272f24c5e84cfbca53a53b544a61304 (diff)
downloadfpm-df531fcffdd5c7b6233d0107152725ce3f8f22c1.tar.gz
fpm-df531fcffdd5c7b6233d0107152725ce3f8f22c1.zip
Add clarifications to PACKAGING.md
Diffstat (limited to 'PACKAGING.md')
-rw-r--r--PACKAGING.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/PACKAGING.md b/PACKAGING.md
index e8086f8..941f1b0 100644
--- a/PACKAGING.md
+++ b/PACKAGING.md
@@ -686,10 +686,16 @@ the build script.
* `FC` - The Fortran compiler to be used
* `FFLAGS` - The flags that should be passed to the Fortran compiler
* `BUILD_DIR` - Where the compiled files should be placed
-* `INCLUDE_DIRS` - The folders where any dependencies can be found
+* `INCLUDE_DIRS` - The folders where any dependencies can be found, space seperated.
+ It is then the responsibility of the build script to generate the appropriate
+ include flags.
Additionally, script will be called with the name of the archive (`*.a` file)
that should be produced as the command line argument.
> Note: If the name of the build script is `Makefile` or ends with `.mk`, then
-> the make program will be used to run it.
+> the make program will be used to run it. Not the the archive file is explicitly
+> specified as the target to be built
+
+> Note: All file and directory names are specified with their full canonical
+> path.