]> git.ipfire.org Git - thirdparty/openvpn.git/commitdiff
README.cmake.md: Document minimum required CMake version for --preset
authorFrank Lichtenheld <frank@lichtenheld.com>
Thu, 1 Feb 2024 12:30:39 +0000 (13:30 +0100)
committerGert Doering <gert@greenie.muc.de>
Fri, 2 Feb 2024 18:18:36 +0000 (19:18 +0100)
CMakePreset.json is supported since 3.19, but we have a version
3 preset file, so need at least 3.21.

Github: OpenVPN/openvpn#489
Change-Id: I44c555f6ffa08f2aee739c7f687fa3b678c86231
Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
Acked-by: Gert Doering <gert@greenie.muc.de>
Message-Id: <20240201123039.174176-1-frank@lichtenheld.com>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg28160.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>
(cherry picked from commit 53b16d07e889b69128203d3b50ed47ceb77c5771)

README.cmake.md

index b590f079af62cd7756983e2a15570c4ef3ecc291..4f0ec1f113c7d23afc401fc9bc91338fa2bf129e 100644 (file)
@@ -17,6 +17,10 @@ also makes cross-building with MinGW on Linux much simpler. However,
 builds are also possible by providing the build dependencies manually,
 but that might require specifying more information to CMake.
 
+You need at least CMake version 3.21 or newer for the `CMakePreset.json`
+file to be supported. Manual builds might be possible with older CMake
+versions, see `cmake_minimum_required` in `CMakeLists.txt`.
+
 If you're looking to build the full Windows installer MSI, take a look
 at https://github.com/OpenVPN/openvpn-build.git .
 
@@ -27,7 +31,7 @@ The following tools are expected to be present on the system, you
 can install them with a package manager of your choice (e.g.
 chocolatey, winget) or manually:
 
-* CMake
+* CMake (>= 3.21)
 * Git
 * Python (3.x), plus the Python module `docutils`
 * Visual Studion 17 (2022), C/C++ Environment
@@ -101,6 +105,7 @@ To build the Windows executables on a Linux system:
     git clone https://github.com/OpenVPN/openvpn.git
     export VCPKG_ROOT=$PWD/vcpkg
     cd openvpn
+    # requires CMake 3.21 or newer
     cmake --preset mingw-x64
     cmake --build --preset mingw-x64
     # unit tests are built, but no testPreset is provided. You need to copy