[FFTW3] Clarify usage of COMPONENTS

DCNick3 · Jun 13, 2017 · 769cb59 · 769cb59
1 parent 543d0e8
commit 769cb59
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/modules/FindFFTW3.cmake b/modules/FindFFTW3.cmake
@@ -1,4 +1,12 @@
 # - Try to find FFTW
+#
+# By default, it will look only for the serial libraries with single, double,
+# and long double precision. Any combination of precision (SINGLE, DOUBLE,
+# LONGDOUBLE) and library type (SERIAL, [THREADS|OPENMP], MPI) is possible by
+# using the COMPONENTS keyword. For example,
+#
+# find_package(FFTW3 COMPONENTS SINGLE DOUBLE OPENMP MPI)
+#
 # Once done this will define
 #  FFTW3_FOUND - System has FFTW3
 #  FFTW3_INCLUDE_DIRS - The FFTW3 include directories