diff --git a/doc/index.rst b/doc/index.rst index 4b6affb..ea8fcac 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -28,6 +28,11 @@ For developers who use Autocmake For users of projects which use Autocmake ----------------------------------------- +.. toctree:: + :maxdepth: 2 + + users/faq.rst + For developers/contributors to Autocmake ---------------------------------------- diff --git a/doc/users/faq.rst b/doc/users/faq.rst new file mode 100644 index 0000000..3098f26 --- /dev/null +++ b/doc/users/faq.rst @@ -0,0 +1,30 @@ + + +FAQ +=== + + +How can I specify the compiler? +------------------------------- + +By default ``setup.py`` will attempt GNU compilers. +You can specify compilers manually like this:: + + $ python setup.py --fc=ifort --cc=icc --cxx=icpc + + +How can I add compiler flags? +----------------------------- + +You can do this with ``--extra-fc-flags``, ``--extra-cc-flags``, or +``--extra-cxx-flags``:: + + $ python setup.py --fc=gfortran --extra-fc-flags='-some-exotic-flag' + + +How can I redefine compiler flags? +---------------------------------- + +If you export compiler flags using the environment variables ``FCFLAGS``, +``CFLAGS``, or ``CXXFLAGS``, respectively, then the configuration will use +those flags and neither augment them, nor redefine them.