From aaeca5c85594a5c0c67f0b575919afd189531dfc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 14 Dec 2021 13:37:03 +0100 Subject: [PATCH] doc: utilities don't require their dependencies to be enabled. Probably a leftover from when these dependencies were handled in a much shittier way? For as long as I remember, enabling WITH_GL_INFO always enabled WITH_GL and WITH_WINDOWLESSWHATEVERAPPLICATION implicitly. --- doc/building.dox | 25 ++++++++++--------- src/Magnum/Audio/al-info.cpp | 9 +++---- src/Magnum/Platform/gl-info.cpp | 8 +++--- src/Magnum/SceneTools/sceneconverter.cpp | 10 ++++---- src/Magnum/ShaderTools/shaderconverter.cpp | 6 ++--- src/Magnum/Text/fontconverter.cpp | 8 +++--- .../TextureTools/distancefieldconverter.cpp | 9 +++---- src/Magnum/Trade/imageconverter.cpp | 8 +++--- src/Magnum/Vk/vk-info.cpp | 8 +++--- 9 files changed, 45 insertions(+), 46 deletions(-) diff --git a/doc/building.dox b/doc/building.dox index 147156a5d..03746ccc1 100644 --- a/doc/building.dox +++ b/doc/building.dox @@ -610,26 +610,27 @@ There are also a few command-line utilities, also all disabled by default: - `WITH_GL_INFO` --- Build the @ref magnum-gl-info "magnum-gl-info" executable, which provides information about the engine OpenGL - capabilities. Requires `TARGET_GL` to be enabled; enables building of one - of the windowless application libraries based on the target platform. + capabilities. Requires `TARGET_GL` to be enabled; enables also building of + the @ref GL library and one of the windowless application libraries based + on the target platform. - `WITH_VK_INFO` --- Build the @ref magnum-vk-info "magnum-vk-info" executable, which provides information about the engine Vulkan - capabilities. Requires `TARGET_VK` to be enabled; enables building of the - @ref Vk library. + capabilities. Requires `TARGET_VK` to be enabled; enables also building of + the @ref Vk library. - `WITH_AL_INFO` --- Build the @ref magnum-al-info "magnum-al-info" executable, which provides information about the engine OpenAL - capabilities. + capabilities. Enables also building of the @ref Audio library. - `WITH_DISTANCEFIELDCONVERTER` --- Build the @ref magnum-distancefieldconverter "magnum-distancefieldconverter" executable for converting black&white images to distance field textures. - Enables also building of the @ref TextureTools library. Available only on - desktop GL. Requires `TARGET_GL` to be enabled; enables building of one of - the windowless application libraries based on the target platform. + Available only on desktop GL. Requires `TARGET_GL` to be enabled; enables + also building of the @ref TextureTools and @ref GL libraries and one of the + windowless application libraries based on the target platform. - `WITH_FONTCONVERTER` --- Build the @ref magnum-fontconverter "magnum-fontconverter" - executable for converting fonts of different formats. Enables also building - of the @ref Text library. Available only on desktop GL. Requires - `TARGET_GL` to be enabled; enables building of one of the windowless - application libraries based on the target platform. + executable for converting fonts of different formats. Available only on + desktop GL. Requires `TARGET_GL` to be enabled; enables also building of + the @ref Text and @ref GL libraries and one of the windowless application + libraries based on the target platform. - `WITH_IMAGECONVERTER` --- Build the @ref magnum-imageconverter "magnum-imageconverter" executable for converting images of different formats. Enables also building of the @ref Trade library. diff --git a/src/Magnum/Audio/al-info.cpp b/src/Magnum/Audio/al-info.cpp index 271cc1e2b..b4a463689 100644 --- a/src/Magnum/Audio/al-info.cpp +++ b/src/Magnum/Audio/al-info.cpp @@ -39,11 +39,10 @@ namespace Magnum { @m_div{m-button m-primary} @m_div{m-big}Live web version @m_enddiv @m_div{m-small} uses WebAssembly & WebAudio @m_enddiv @m_enddiv -This utility depends on the [OpenAL](https://www.openal.org/) library. It is -built if both `WITH_AUDIO` and `WITH_AL_INFO` is enabled when building Magnum. -To use this utility with CMake, you need to request the `al-info` component of -the `Magnum` package and use the `Magnum::al-info` target for example in a -custom command: +This utility is built if `WITH_AL_INFO` is enabled when building Magnum. To use +this utility with CMake, you need to request the `al-info` component of the +`Magnum` package and use the `Magnum::al-info` target for example in a custom +command: @code{.cmake} find_package(Magnum REQUIRED al-info) diff --git a/src/Magnum/Platform/gl-info.cpp b/src/Magnum/Platform/gl-info.cpp index b55316d16..640067a3f 100644 --- a/src/Magnum/Platform/gl-info.cpp +++ b/src/Magnum/Platform/gl-info.cpp @@ -91,10 +91,10 @@ namespace Magnum { @m_div{m-button m-primary} @m_div{m-big}Live web version @m_enddiv @m_div{m-small} uses WebAssembly & WebGL @m_enddiv @m_enddiv -This utility is built if both `WITH_GL` and `WITH_GL_INFO` is enabled when -building Magnum. To use this utility with CMake, you need to request the -`gl-info` component of the `Magnum` package and use the `Magnum::gl-info` -target for example in a custom command: +This utility is built if `WITH_GL_INFO` is enabled when building Magnum. To use +this utility with CMake, you need to request the `gl-info` component of the +`Magnum` package and use the `Magnum::gl-info` target for example in a custom +command: @code{.cmake} find_package(Magnum REQUIRED gl-info) diff --git a/src/Magnum/SceneTools/sceneconverter.cpp b/src/Magnum/SceneTools/sceneconverter.cpp index 639fa25e8..8526f9440 100644 --- a/src/Magnum/SceneTools/sceneconverter.cpp +++ b/src/Magnum/SceneTools/sceneconverter.cpp @@ -60,10 +60,10 @@ namespace Magnum { @m_footernavigation @m_keywords{magnum-sceneconverter sceneconverter} -This utility is built if both `WITH_TRADE` and `WITH_SCENECONVERTER` is enabled -when building Magnum. To use this utility with CMake, you need to request the -`sceneconverter` component of the `Magnum` package and use the -`Magnum::sceneconverter` target for example in a custom command: +This utility is built if `WITH_SCENECONVERTER` is enabled when building Magnum. +To use this utility with CMake, you need to request the `sceneconverter` +component of the `Magnum` package and use the `Magnum::sceneconverter` target +for example in a custom command: @code{.cmake} find_package(Magnum REQUIRED imageconverter) @@ -71,7 +71,7 @@ find_package(Magnum REQUIRED imageconverter) add_custom_command(OUTPUT ... COMMAND Magnum::sceneconverter ...) @endcode -See @ref building, @ref cmake and the @ref Trade namespace for more +See @ref building and @ref cmake and the @ref Trade namespace for more information. @section magnum-sceneconverter-usage Usage diff --git a/src/Magnum/ShaderTools/shaderconverter.cpp b/src/Magnum/ShaderTools/shaderconverter.cpp index 55d1c252b..d414d7105 100644 --- a/src/Magnum/ShaderTools/shaderconverter.cpp +++ b/src/Magnum/ShaderTools/shaderconverter.cpp @@ -45,9 +45,9 @@ namespace Magnum { @m_footernavigation @m_keywords{magnum-shaderconverter shaderconverter} -This utility is built if both `WITH_SHADERTOOLS` and `WITH_SHADERCONVERTER` is -enabled when building Magnum. To use this utility with CMake, you need to -request the `shaderconverter` component of the `Magnum` package and use the +This utility is built if `WITH_SHADERCONVERTER` is enabled when building +Magnum. To use this utility with CMake, you need to request the +`shaderconverter` component of the `Magnum` package and use the `Magnum::shaderconverter` target for example in a custom command: @code{.cmake} diff --git a/src/Magnum/Text/fontconverter.cpp b/src/Magnum/Text/fontconverter.cpp index 9ef08563c..8bb3c3511 100644 --- a/src/Magnum/Text/fontconverter.cpp +++ b/src/Magnum/Text/fontconverter.cpp @@ -65,10 +65,10 @@ namespace Magnum { @m_footernavigation @m_keywords{magnum-fontconverter fontconverter} -This utility is built if both `WITH_TEXT` and `WITH_FONTCONVERTER` is enabled -when building Magnum. To use this utility with CMake, you need to request the -`fontconverter` component of the `Magnum` package and use the -`Magnum::fontconverter` target for example in a custom command: +This utility is built if `WITH_FONTCONVERTER` is enabled when building Magnum. +To use this utility with CMake, you need to request the `fontconverter` +component of the `Magnum` package and use the `Magnum::fontconverter` target +for example in a custom command: @code{.cmake} find_package(Magnum REQUIRED fontconverter) diff --git a/src/Magnum/TextureTools/distancefieldconverter.cpp b/src/Magnum/TextureTools/distancefieldconverter.cpp index 8b70a56ca..2b3c8248d 100644 --- a/src/Magnum/TextureTools/distancefieldconverter.cpp +++ b/src/Magnum/TextureTools/distancefieldconverter.cpp @@ -72,11 +72,10 @@ namespace Magnum { @m_footernavigation @m_keywords{magnum-distancefieldconverter distancefieldconverter} -This utility is built if both `WITH_TEXTURETOOLS` and -`WITH_DISTANCEFIELDCONVERTER` is enabled when building Magnum. To use this -utility with CMake, you need to request the `distancefieldconverter` component -of the `Magnum` package and use the `Magnum::distancefieldconverter` target for -example in a custom command: +This utility is built if `WITH_DISTANCEFIELDCONVERTER` is enabled when building +Magnum. To use this utility with CMake, you need to request the +`distancefieldconverter` component of the `Magnum` package and use the +`Magnum::distancefieldconverter` target for example in a custom command: @code{.cmake} find_package(Magnum REQUIRED distancefieldconverter) diff --git a/src/Magnum/Trade/imageconverter.cpp b/src/Magnum/Trade/imageconverter.cpp index e920806d1..16add71e2 100644 --- a/src/Magnum/Trade/imageconverter.cpp +++ b/src/Magnum/Trade/imageconverter.cpp @@ -51,10 +51,10 @@ namespace Magnum { @m_footernavigation @m_keywords{magnum-imageconverter imageconverter} -This utility is built if both `WITH_TRADE` and `WITH_IMAGECONVERTER` is enabled -when building Magnum. To use this utility with CMake, you need to request the -`imageconverter` component of the `Magnum` package and use the -`Magnum::imageconverter` target for example in a custom command: +This utility is built if `WITH_IMAGECONVERTER` is enabled when building Magnum. +To use this utility with CMake, you need to request the `imageconverter` +component of the `Magnum` package and use the `Magnum::imageconverter` target +for example in a custom command: @code{.cmake} find_package(Magnum REQUIRED imageconverter) diff --git a/src/Magnum/Vk/vk-info.cpp b/src/Magnum/Vk/vk-info.cpp index 90b8778cd..966887c30 100644 --- a/src/Magnum/Vk/vk-info.cpp +++ b/src/Magnum/Vk/vk-info.cpp @@ -43,10 +43,10 @@ namespace Magnum { @m_footernavigation @m_keywords{magnum-vk-info vk-info} -This utility is built if both `WITH_VK` and `WITH_VK_INFO` is enabled when -building Magnum. To use this utility with CMake, you need to request the -`vk-info` component of the `Magnum` package and use the `Magnum::vk-info` -target for example in a custom command: +This utility is built if `WITH_VK_INFO` is enabled when building Magnum. To use +this utility with CMake, you need to request the `vk-info` component of the +`Magnum` package and use the `Magnum::vk-info` target for example in a custom +command: @code{.cmake} find_package(Magnum REQUIRED vk-info)