aboutsummaryrefslogtreecommitdiff
path: root/README.cmake.md
diff options
context:
space:
mode:
authorFrank Lichtenheld2024-02-01 13:30:39 +0100
committerGert Doering2024-02-02 19:18:36 +0100
commit9ec524613662989ab165d8ca507c2e0abffc3dff (patch)
tree4fcfce6e4f21362afad93bd9f4bc729948366af4 /README.cmake.md
parent1141e7505747dd6029ac7cf19b6c2de99a685ccc (diff)
downloadopenvpn-9ec524613662989ab165d8ca507c2e0abffc3dff.zip
openvpn-9ec524613662989ab165d8ca507c2e0abffc3dff.tar.gz
README.cmake.md: Document minimum required CMake version for --preset
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)
Diffstat (limited to 'README.cmake.md')
-rw-r--r--README.cmake.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.cmake.md b/README.cmake.md
index b590f07..4f0ec1f 100644
--- a/README.cmake.md
+++ b/README.cmake.md
@@ -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