From a8526f5a19296ca993409f385a1e92b0154c7ab1 Mon Sep 17 00:00:00 2001
From: Anonymous Maarten <[EMAIL REDACTED]>
Date: Thu, 2 May 2024 19:44:58 +0200
Subject: [PATCH] cmake: disable documentation installation by default
---
.github/workflows/android.yml | 1 +
.github/workflows/cpactions.yml | 1 +
.github/workflows/emscripten.yml | 1 +
.github/workflows/haiku.yml | 1 +
.github/workflows/loongarch64.yml | 1 +
.github/workflows/main.yml | 1 +
.github/workflows/n3ds.yml | 1 +
.github/workflows/ppc64le.yml | 1 +
.github/workflows/ps2.yml | 1 +
.github/workflows/psp.yml | 1 +
.github/workflows/riscos.yml | 1 +
.github/workflows/vita.yml | 1 +
CMakeLists.txt | 2 +-
13 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/.github/workflows/android.yml b/.github/workflows/android.yml
index 0c31a5768519a..aa0402549ede0 100644
--- a/.github/workflows/android.yml
+++ b/.github/workflows/android.yml
@@ -52,6 +52,7 @@ jobs:
-DSDL_TESTS=ON \
-DSDL_INSTALL_TESTS=ON \
-DSDL_CLANG_TIDY=ON \
+ -DSDL_DISABLE_INSTALL_DOCS=OFF \
-DANDROID_PLATFORM=${{ matrix.platform.android_platform }} \
-DANDROID_ABI=${{ matrix.platform.android_abi }} \
-DSDL_SHARED=ON \
diff --git a/.github/workflows/cpactions.yml b/.github/workflows/cpactions.yml
index 02ae6a420736e..cf57a7ec02f00 100644
--- a/.github/workflows/cpactions.yml
+++ b/.github/workflows/cpactions.yml
@@ -40,6 +40,7 @@ jobs:
-Wdeprecated -Wdev -Werror \
-DCMAKE_BUILD_TYPE=Release \
-DSDL_WERROR=ON \
+ -DSDL_DISABLE_INSTALL_DOCS=OFF \
${{ matrix.platform.sdl-cmake-configure-arguments }}
cmake --build build/ --config Release --verbose
cmake --build build/ --config Release --target package
diff --git a/.github/workflows/emscripten.yml b/.github/workflows/emscripten.yml
index eedbb42bbc2a1..25eef05ffc099 100644
--- a/.github/workflows/emscripten.yml
+++ b/.github/workflows/emscripten.yml
@@ -49,6 +49,7 @@ jobs:
-DCMAKE_BUILD_TYPE=Debug \
-DSDL_VENDOR_INFO="Github Workflow" \
-DTEST_SHARED=FALSE \
+ -DSDL_DISABLE_INSTALL_DOCS=OFF \
-DCMAKE_PREFIX_PATH=${{ env.SDL3_DIR }}
cmake --build cmake_config_build --verbose
- uses: actions/upload-artifact@v4
diff --git a/.github/workflows/haiku.yml b/.github/workflows/haiku.yml
index b1caee982fb60..709d86698dc3d 100644
--- a/.github/workflows/haiku.yml
+++ b/.github/workflows/haiku.yml
@@ -27,6 +27,7 @@ jobs:
-DSDL_INSTALL_TESTS=ON \
-DSDL_VENDOR_INFO=Github_Workflow \
-DCMAKE_INSTALL_PREFIX=cmake_prefix \
+ -DSDL_DISABLE_INSTALL_DOCS=OFF \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_SYSTEM_NAME=Haiku
- name: Build (CMake)
diff --git a/.github/workflows/loongarch64.yml b/.github/workflows/loongarch64.yml
index ae46e3e13456b..6cb65ca9a0ccb 100644
--- a/.github/workflows/loongarch64.yml
+++ b/.github/workflows/loongarch64.yml
@@ -59,6 +59,7 @@ jobs:
-DSDL_WERROR=ON \
-DSDL_TESTS=ON \
-DSDL_INSTALL_TESTS=ON \
+ -DSDL_DISABLE_INSTALL_DOCS=OFF \
-DSDL_VENDOR_INFO="Github Workflow" \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=prefix
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index cb7dabdada9f3..a4e00d6424b48 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -109,6 +109,7 @@ jobs:
-DSDL_INSTALL_TESTS=ON \
-DSDL_VENDOR_INFO="Github Workflow" \
-DSDL_CLANG_TIDY=ON \
+ -DSDL_DISABLE_INSTALL_DOCS=OFF \
-DCMAKE_INSTALL_PREFIX=cmake_prefix \
-DCMAKE_BUILD_TYPE=Release \
${{ matrix.platform.cmake-platform }} \
diff --git a/.github/workflows/n3ds.yml b/.github/workflows/n3ds.yml
index dcf99a124342f..33c4b9a0ec125 100644
--- a/.github/workflows/n3ds.yml
+++ b/.github/workflows/n3ds.yml
@@ -25,6 +25,7 @@ jobs:
-DSDL_WERROR=ON \
-DSDL_TESTS=ON \
-DSDL_INSTALL_TESTS=ON \
+ -DSDL_DISABLE_INSTALL_DOCS=OFF \
-DSDL_VENDOR_INFO="Github Workflow" \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=prefix
diff --git a/.github/workflows/ppc64le.yml b/.github/workflows/ppc64le.yml
index 4d8190e3e4e24..5cb2d318b0f7d 100644
--- a/.github/workflows/ppc64le.yml
+++ b/.github/workflows/ppc64le.yml
@@ -28,6 +28,7 @@ jobs:
-DSDL_WERROR=OFF \
-DSDL_TESTS=ON \
-DSDL_INSTALL_TESTS=ON \
+ -DSDL_DISABLE_INSTALL_DOCS=OFF \
-DSDL_VENDOR_INFO="Github Workflow" \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=prefix
diff --git a/.github/workflows/ps2.yml b/.github/workflows/ps2.yml
index 2b882161702c5..c76c3d5f63417 100644
--- a/.github/workflows/ps2.yml
+++ b/.github/workflows/ps2.yml
@@ -24,6 +24,7 @@ jobs:
-DSDL_WERROR=ON \
-DSDL_TESTS=ON \
-DSDL_INSTALL_TESTS=ON \
+ -DSDL_DISABLE_INSTALL_DOCS=OFF \
-DCMAKE_INSTALL_PREFIX=cmake_prefix \
-DCMAKE_BUILD_TYPE=Release
- name: Build (CMake)
diff --git a/.github/workflows/psp.yml b/.github/workflows/psp.yml
index 37c70ac079711..18b31b819c7e1 100644
--- a/.github/workflows/psp.yml
+++ b/.github/workflows/psp.yml
@@ -39,6 +39,7 @@ jobs:
-DSDL_WERROR=ON \
-DSDL_TESTS=ON \
-DSDL_INSTALL_TESTS=ON \
+ -DSDL_DISABLE_INSTALL_DOCS=OFF \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=prefix
- name: Build (CMake)
diff --git a/.github/workflows/riscos.yml b/.github/workflows/riscos.yml
index 1fff80098bb8d..b7183fc5c3b33 100644
--- a/.github/workflows/riscos.yml
+++ b/.github/workflows/riscos.yml
@@ -33,6 +33,7 @@ jobs:
-DSDL_GCC_ATOMICS=OFF \
-DSDL_TESTS=ON \
-DSDL_INSTALL_TESTS=ON \
+ -DSDL_DISABLE_INSTALL_DOCS=OFF \
-DSDL_VENDOR_INFO="Github Workflow" \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=${{ github.workspace }}/prefix_cmake
diff --git a/.github/workflows/vita.yml b/.github/workflows/vita.yml
index dddc425196244..6e66a74732305 100644
--- a/.github/workflows/vita.yml
+++ b/.github/workflows/vita.yml
@@ -104,6 +104,7 @@ jobs:
-DSDL_WERROR=ON \
-DSDL_TESTS=ON \
-DSDL_INSTALL_TESTS=ON \
+ -DSDL_DISABLE_INSTALL_DOCS=OFF \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=prefix
- name: Build (CMake)
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 01b1e6cbcc30e..e81b9efd9f9cd 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -271,7 +271,7 @@ endif()
# Allow some projects to be built conditionally.
set_option(SDL_DISABLE_INSTALL "Disable installation of SDL3" ${SDL3_SUBPROJECT})
cmake_dependent_option(SDL_DISABLE_INSTALL_CPACK "Create binary SDL3 archive using CPack" ${SDL3_SUBPROJECT} "NOT SDL_DISABLE_INSTALL" ON)
-cmake_dependent_option(SDL_DISABLE_INSTALL_DOCS "Install docs for SDL3" ${SDL3_SUBPROJECT} "NOT SDL_DISABLE_INSTALL;NOT SDL_FRAMEWORK" ON)
+cmake_dependent_option(SDL_DISABLE_INSTALL_DOCS "Install docs for SDL3" ON "NOT SDL_DISABLE_INSTALL;NOT SDL_FRAMEWORK" ON)
set_option(SDL_DISABLE_UNINSTALL "Disable uninstallation of SDL3" OFF)
cmake_dependent_option(SDL_DISABLE_ANDROID_JAR "Disable creation of SDL3.jar" ${SDL3_SUBPROJECT} "ANDROID" ON)