From 926740961d80a0cbfe834615083557d5963cd1c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 11 Jan 2015 17:38:17 +0100 Subject: [PATCH] doc: better info about debug/release plugin dirs. Someone should already tell me that all my writing sucks and the documentation is incomprehensible wall of text. Thanks in advance. --- doc/plugins.dox | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/doc/plugins.dox b/doc/plugins.dox index 20b5b7da1..2a015f567 100644 --- a/doc/plugins.dox +++ b/doc/plugins.dox @@ -98,10 +98,11 @@ to these: In case you are using multi-configuration build system (such as Visual Studio or XCode), CMake cannot provide separate plugin directory for debug and release -build and you have to do it on your own in preprocessing step using -@ref corrade-cmake "CORRADE_IS_DEBUG_BUILD" variable. This will ensure that you -use debug plugin directory for debug build on multi-configuration build sytems -and fall back to autodetection for the rest: +build and you have to select between `MAGNUM_PLUGINS_*_DIR` and +`MAGNUM_PLUGINS_*_DEBUG_DIR` based on @ref corrade-cmake "CORRADE_IS_DEBUG_BUILD" +preprocessor variable. This will ensure that you use debug plugin directory for +debug build on multi-configuration build sytems and fall back to autodetection +for the rest: @code #ifdef CORRADE_IS_DEBUG_BUILD #define MAGNUM_PLUGINS_IMPORTER_DIR "${MAGNUM_PLUGINS_IMPORTER_DEBUG_DIR}" @@ -110,6 +111,11 @@ and fall back to autodetection for the rest: #endif @endcode +However, if you want to use only one (debug/release) plugin version for both +debug and release configurations of the application, you need to edit +`MAGNUM_PLUGINS_DIR` or `MAGNUM_PLUGINS_DEBUG_DIR` using CMake and point them +to directory containing desired plugin version. + Then process the file in your `CMakeLists.txt`. The result (`${MAGNUM_PLUGINS_IMPORTER_DIR}` / `${MAGNUM_PLUGINS_IMPORTER_DEBUG_DIR}` gets replaced with the actual value) is put into build directory, so don't forget to