Skip to content

Commit b18a2f9

Browse files
docs: add a warning to clean before changing build options
1 parent de50286 commit b18a2f9

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

docs/source/developing/build-system.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@ Running ``make`` in the root folder will build all the modules, install relevant
1111
Build options
1212
=============
1313

14-
The build system exposes several options to control the build process. If you want to change these options, give them as arguments to make, e.g. ``make BUILD_DIR=my_build_dir``.
14+
The build system exposes several options to control the build process. If you want to change these options, give them as arguments to make, e.g. ``make BUILD_DIR=my_build_dir`` or set them in your environment.
15+
16+
.. warning::
17+
18+
If you change any of these options, make sure the clean the build outputs with `make clean`. Otherwise the change to the option may not apply at all, or even causing a weird hybrid build.
1519

1620
* **BUILD_DIR**: Where all compiled files will end up, default is ``build``. The output from each module's build will be in a subfolder with the module's name.
1721
* **COMPILER**: Which compiler to use. Supported options are ``gfortran`` (default).

0 commit comments

Comments
 (0)