diff --git a/docs/source/install.rst b/docs/source/install.rst index 3929f78ad2..1190819768 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -446,6 +446,25 @@ All cached entries can be viewed using ``cmake -LAH`` from a build directory. Embed ``PROJ_DATA`` hard-coded alternative path for data files location. Disable to avoid setting this non-relocatable hard-coded path. Default ON. +.. option:: EMBED_RESOURCE_FILES=ON/OFF + + .. versionadded:: 9.6 + + Default is OFF for shared library builds (BUILD_SHARED_LIBS=ON), and ON + for static library builds (BUILD_SHARED_LIBS=OFF). + When ON, :file:`proj.db` will be embedded into the PROJ library. + +.. option:: USE_ONLY_EMBEDDED_RESOURCE_FILES=ON/OFF + + .. versionadded:: 9.6 + + Even if EMBED_RESOURCE_FILES=ON, by default PROJ will still try to locate + :file:`proj.db` on the file system, and fallback to the embedded version if + not found. By setting USE_ONLY_EMBEDDED_RESOURCE_FILES=OFF, no attempt + at localing :file:`proj.db` on the file system is made. + Users will also typically want to set EMBED_PROJ_DATA_PATH=OFF if setting + USE_ONLY_EMBEDDED_RESOURCE_FILES=OFF. + Building on Windows with vcpkg and Visual Studio 2017 or 2019 --------------------------------------------------------------------------------