[Openvpn-devel] README.cmake.md: Document minimum required CMake version for --preset

Message ID 20240201123039.174176-1-frank@lichtenheld.com
State Accepted
Headers show
Series [Openvpn-devel] README.cmake.md: Document minimum required CMake version for --preset | expand

Commit Message

Frank Lichtenheld Feb. 1, 2024, 12:30 p.m. UTC
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>
---
 README.cmake.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

Comments

Gert Doering Feb. 1, 2024, 7:28 p.m. UTC | #1
Makes sense (I did read the GH issue).

Your patch has been applied to the master branch.

commit 53b16d07e889b69128203d3b50ed47ceb77c5771
Author: Frank Lichtenheld
Date:   Thu Feb 1 13:30:39 2024 +0100

     README.cmake.md: Document minimum required CMake version for --preset

     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>


--
kind regards,

Gert Doering
Frank Lichtenheld Feb. 2, 2024, 11:27 a.m. UTC | #2
On Thu, Feb 01, 2024 at 08:28:21PM +0100, Gert Doering wrote:
> Makes sense (I did read the GH issue).
> 
> Your patch has been applied to the master branch.

I think it would make sense to apply this to release/2.6 as well, since
that uses the same CMake build.

Thanks,
Gert Doering Feb. 2, 2024, 6:19 p.m. UTC | #3
Hi,

On Fri, Feb 02, 2024 at 12:27:19PM +0100, Frank Lichtenheld wrote:
> On Thu, Feb 01, 2024 at 08:28:21PM +0100, Gert Doering wrote:
> > Makes sense (I did read the GH issue).
> > 
> > Your patch has been applied to the master branch.
> 
> I think it would make sense to apply this to release/2.6 as well, since
> that uses the same CMake build.

Done!

commit 9ec524613662989ab165d8ca507c2e0abffc3dff (HEAD -> release/2.6)
Author: Frank Lichtenheld <frank@lichtenheld.com>
Date:   Thu Feb 1 13:30:39 2024 +0100

    README.cmake.md: Document minimum required CMake version for --preset


gert

Patch

diff --git a/README.cmake.md b/README.cmake.md
index 4f41c701..89d9419d 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++ Enviroment
@@ -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