From 62e7128ff616d0295e75cfbf8ce3f84a8e8b5bfb Mon Sep 17 00:00:00 2001
From: Adriaan de Groot <groot@kde.org>
Date: Tue, 16 Jun 2020 13:54:13 +0200
Subject: [PATCH] CMake: document WITH_ and BUILD_ a little more

- also mark TODO:3.3: for incompatible / surprising changes for 3.3
---
 CMakeLists.txt                            | 12 ++++++++----
 src/modules/packagechooser/CMakeLists.txt |  1 +
 2 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 269b2e9b1..b643dbd51 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -27,8 +27,12 @@
 #   USE_<foo>       : fills in SKIP_MODULES for modules called <foo>-<something>
 #   WITH_<foo>      : try to enable <foo> (these usually default to ON). For
 #                     a list of WITH_<foo> grep CMakeCache.txt after running
-#                     CMake once.
+#                     CMake once. These affect the ABI offered by Calamares.
+#                       - PYTHON (enable Python Job modules)
+#                       - QML (enable QML UI View modules)
+#                       - PYTHONQT # TODO:3.3: remove
 #   BUILD_<foo>     : choose additional things to build
+#                       - TESTING (standard CMake option)
 #   DEBUG_<foo>     : special developer flags for debugging
 #
 # Example usage:
@@ -51,12 +55,12 @@ option( INSTALL_CONFIG "Install configuration files" OFF )
 option( INSTALL_POLKIT "Install Polkit configuration" ON )
 option( INSTALL_COMPLETION "Install shell completions" OFF )
 # Options for the calamares executable
-option( WITH_KF5Crash "Enable crash reporting with KCrash." ON )
-option( WITH_KF5DBus "Use DBus service for unique-application." OFF )
+option( WITH_KF5Crash "Enable crash reporting with KCrash." ON )  # TODO:3.3: WITH->BUILD (this isn't an ABI thing)
+option( WITH_KF5DBus "Use DBus service for unique-application." OFF )  # TODO:3.3: WITH->BUILD
 # When adding WITH_* that affects the ABI offered by libcalamares,
 # also update libcalamares/CalamaresConfig.h.in
 option( WITH_PYTHON "Enable Python modules API (requires Boost.Python)." ON )
-option( WITH_PYTHONQT "Enable Python view modules API (deprecated, requires PythonQt)." OFF )
+option( WITH_PYTHONQT "Enable Python view modules API (deprecated, requires PythonQt)." OFF )  # TODO:3.3: remove
 option( WITH_QML "Enable QML UI options." ON )
 
 # Possible debugging flags are:
diff --git a/src/modules/packagechooser/CMakeLists.txt b/src/modules/packagechooser/CMakeLists.txt
index d85eda8e2..d949829de 100644
--- a/src/modules/packagechooser/CMakeLists.txt
+++ b/src/modules/packagechooser/CMakeLists.txt
@@ -5,6 +5,7 @@ set( _extra_src "" )
 ### OPTIONAL AppData XML support in PackageModel
 #
 #
+# TODO:3.3:WITH->BUILD (this doesn't affect the ABI offered by Calamares)
 option( WITH_APPDATA "Support appdata: items in PackageChooser (requires QtXml)" ON )
 if ( WITH_APPDATA )
     find_package(Qt5 COMPONENTS Xml)