From dfb3f58f79b05dfe7840373aa08a86204c94f33b Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 1 Nov 2018 13:12:18 -0400 Subject: FindGDAL: Modernize documentation layout --- Modules/FindGDAL.cmake | 33 +++++++++++++++++++++------------ 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/Modules/FindGDAL.cmake b/Modules/FindGDAL.cmake index 030553f..9c989b8 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. -- cgit v0.12