diff options
| author | Brad King <brad.king@kitware.com> | 2018-11-01 13:12:18 -0400 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2018-11-01 13:16:36 -0400 |
| commit | dfb3f58f79b05dfe7840373aa08a86204c94f33b (patch) | |
| tree | 9c4ed165e1e302ad2ea2233a1e1c8e106d2360d2 /Modules/FindGDAL.cmake | |
| parent | 7f68e4a1636a1691422e7a97873d34e1f5612fa1 (diff) | |
| download | cmake-dfb3f58f79b05dfe7840373aa08a86204c94f33b.tar.gz | |
FindGDAL: Modernize documentation layout
Diffstat (limited to 'Modules/FindGDAL.cmake')
| -rw-r--r-- | Modules/FindGDAL.cmake | 33 |
1 files changed, 21 insertions, 12 deletions
diff --git a/Modules/FindGDAL.cmake b/Modules/FindGDAL.cmake index 030553faf1..9c989b888a 100644 --- a/Modules/FindGDAL.cmake +++ b/Modules/FindGDAL.cmake @@ -5,28 +5,37 @@ FindGDAL -------- +Find GDAL. +Result Variables +^^^^^^^^^^^^^^^^ -Locate gdal +This module will set the following variables in your project: -This module accepts the following environment variables: +``GDAL_FOUND`` + True if GDAL is found. +``GDAL_INCLUDE_DIRS`` + Include directories for GDAL headers. +``GDAL_LIBRARIES`` + Libraries to link to GDAL. -:: +Cache variables +^^^^^^^^^^^^^^^ - GDAL_DIR or GDAL_ROOT - Specify the location of GDAL +The following cache variables may also be set: +``GDAL_LIBRARY`` + The libgdal library file. +``GDAL_INCLUDE_DIR`` + The directory containing ``gdal.h``. +Hints +^^^^^ -This module defines the following CMake variables: - -:: - - GDAL_FOUND - True if libgdal is found - GDAL_LIBRARY - A variable pointing to the GDAL library - GDAL_INCLUDE_DIR - Where to find the headers +Set ``GDAL_DIR`` or ``GDAL_ROOT`` in the environment to specify the +GDAL installation prefix. #]=======================================================================] -# # $GDALDIR is an environment variable that would # correspond to the ./configure --prefix=$GDAL_DIR # used in building gdal. |