From: "cron2 (Code Review)" Date: Wed, 17 Jan 2024 14:02:47 +0000 In-Reply-To: References: Reply-To: gert@...1296..., arne-openvpn@...1227..., heiko@...515..., openvpn-devel@lists.sourceforge.net, frank@...2641..., lstipakov@...277... Message-ID: <1e73ec5867b36565edac68efff68a77b346beb20-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="ZGpC7NXBRYc="; charset=UTF-8 Subject: [Openvpn-devel] [M] Change in openvpn[master]: cmake: symlink whole build dir not just .json file List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: d12fk Cc: stipa , plaisthos , flichtenheld , openvpn-devel --ZGpC7NXBRYc= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable cron2 has submitted this change. ( http://gerrit.openvpn.net/c/openvpn/+/50= 1?usp=3Demail ) Change subject: cmake: symlink whole build dir not just .json file ...................................................................... cmake: symlink whole build dir not just .json file It turned out that symlinking compile_commands.json from the top level source dir has some issues: * file is not created on Windows and symlinking may cause an error * some IDEs create their own json and error out b/c a file exists Since clangd also looks for the json in build/ directories by default, we now symlink the whole build directory instead, not just the json file. This approach requires for the existing build/ dir in the repo to vanish. Luckily it only contains one automake include file, which is moved to the top level source dir. Lastly, make this an opt-in feature, so that the default configuration of the buildsystem never causes a build failure because of this. Change-Id: Ib1a5c788269949d8de95d1da2cb0c32a65bf13f2 Signed-off-by: Heiko Hund Acked-by: Gert Doering Message-Id: <20240117134929.5317-1-gert@...1296...> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg28= 061.html Signed-off-by: Gert Doering --- M .gitignore M CMakeLists.txt M Makefile.am M README.cmake.md D build/Makefile.am M configure.ac R ltrc.inc M src/openvpn/Makefile.am M src/openvpnmsica/Makefile.am M src/openvpnserv/Makefile.am M src/tapctl/Makefile.am 11 files changed, 32 insertions(+), 25 deletions(-) diff --git a/.gitignore b/.gitignore index 4153a3e..92d65bf 100644 --- a/.gitignore +++ b/.gitignore @@ -40,7 +40,7 @@ m4/ltversion.m4 m4/lt~obsolete.m4 -compile_commands.json +build doc/openvpn-examples.5 doc/openvpn-examples.5.html doc/openvpn.8 diff --git a/CMakeLists.txt b/CMakeLists.txt index 6a1895a..5e07d50 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -43,9 +43,17 @@ set(PLUGIN_DIR /usr/local/lib/openvpn/plugins CACHE FILEPATH "Location of = the plugin directory") # Create machine readable compile commands -set(CMAKE_EXPORT_COMPILE_COMMANDS 1) -file(CREATE_LINK ${CMAKE_CURRENT_BINARY_DIR}/compile_commands.json - ${CMAKE_CURRENT_SOURCE_DIR}/compile_commands.json SYMBOLI= C) +option(ENABLE_COMPILE_COMMANDS "Generate compile_commands.json and a symli= nk for clangd to find it" OFF) +if (ENABLE_COMPILE_COMMANDS) + if (EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/build AND NOT IS_SYMLINK ${CMAK= E_CURRENT_SOURCE_DIR}/build) + message(FATAL_ERROR "The top level source directory contains a 'bu= ild' file or directory. Please remove or rename it. CMake creates a symlink= with that name during build.") + endif() + set(CMAKE_EXPORT_COMPILE_COMMANDS 1) + add_custom_target( + symlink-build-dir ALL + ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_BINARY_DIR} ${C= MAKE_CURRENT_SOURCE_DIR}/build + ) +endif () # AddressSanitize - use CXX=3Dclang++ CC=3Dclang cmake -DCMAKE_BUILD_TYPE= =3Dasan to build with ASAN set(CMAKE_C_FLAGS_ASAN diff --git a/Makefile.am b/Makefile.am index 2305ab4..792588a 100644 --- a/Makefile.am +++ b/Makefile.am @@ -42,6 +42,7 @@ EXTRA_DIST =3D \ contrib \ debug \ + ltrc.inc \ CMakeLists.txt \ CMakePresets.json \ config.h.cmake.in @@ -53,7 +54,7 @@ config-version.h endif -SUBDIRS =3D build distro include src sample doc tests +SUBDIRS =3D distro include src sample doc tests dist_doc_DATA =3D \ README \ diff --git a/README.cmake.md b/README.cmake.md index d181b64..4f41c70 100644 --- a/README.cmake.md +++ b/README.cmake.md @@ -135,3 +135,17 @@ The `unix-native` CMake preset is available for these builds. This preset = does not require VCPKG and instead assumes all build-dependencies are provided = by the system natively. + +Generating compile_commands.json +-------------------------------- + +To have the CMake buildsystem generate compile_commands.json you can speci= fy +`-DENABLE_COMPILE_COMMANDS=3DON` on the command line or enable the CMake o= ption +another way you like. For supported generators the file will then be creat= ed. +Additionally, the buildsystem will create a symlink `build/` to the --pres= et +build directory that contains the generated JSON file. This is done so that +clangd is able to find it. + +Enabling this option may cause an error on Windows, since creating a symli= nk +is a privileged operation there. If you enable Developer Mode for the syst= em, +symlinks can be created by regular users. diff --git a/build/Makefile.am b/build/Makefile.am deleted file mode 100644 index e7cc4d8..0000000 --- a/build/Makefile.am +++ /dev/null @@ -1,15 +0,0 @@ -# -# OpenVPN -- An application to securely tunnel IP networks -# over a single UDP port, with support for SSL/TLS-based -# session authentication and key exchange, -# packet encryption, packet authentication, and -# packet compression. -# -# Copyright (C) 2002-2023 OpenVPN Inc -# - -MAINTAINERCLEANFILES =3D \ - $(srcdir)/Makefile.in - -EXTRA_DIST =3D \ - ltrc.inc diff --git a/configure.ac b/configure.ac index 3ad9f14..14f5be4 100644 --- a/configure.ac +++ b/configure.ac @@ -1536,7 +1536,6 @@ AC_CONFIG_FILES([ Makefile - build/Makefile distro/Makefile distro/systemd/Makefile doc/Makefile diff --git a/build/ltrc.inc b/ltrc.inc similarity index 100% rename from build/ltrc.inc rename to ltrc.inc diff --git a/src/openvpn/Makefile.am b/src/openvpn/Makefile.am index b953961..1dc1dda 100644 --- a/src/openvpn/Makefile.am +++ b/src/openvpn/Makefile.am @@ -9,7 +9,7 @@ # Copyright (C) 2006-2012 Alon Bar-Lev # -include $(top_srcdir)/build/ltrc.inc +include $(top_srcdir)/ltrc.inc MAINTAINERCLEANFILES =3D \ $(srcdir)/Makefile.in diff --git a/src/openvpnmsica/Makefile.am b/src/openvpnmsica/Makefile.am index dc53f75..b10ce82 100644 --- a/src/openvpnmsica/Makefile.am +++ b/src/openvpnmsica/Makefile.am @@ -18,7 +18,7 @@ # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. # -include $(top_srcdir)/build/ltrc.inc +include $(top_srcdir)/ltrc.inc MAINTAINERCLEANFILES =3D $(srcdir)/Makefile.in diff --git a/src/openvpnserv/Makefile.am b/src/openvpnserv/Makefile.am index d8ba4eb..0c64cce 100644 --- a/src/openvpnserv/Makefile.am +++ b/src/openvpnserv/Makefile.am @@ -9,7 +9,7 @@ # Copyright (C) 2006-2012 Alon Bar-Lev # -include $(top_srcdir)/build/ltrc.inc +include $(top_srcdir)/ltrc.inc MAINTAINERCLEANFILES =3D $(srcdir)/Makefile.in diff --git a/src/tapctl/Makefile.am b/src/tapctl/Makefile.am index 69ea161..4c2958b 100644 --- a/src/tapctl/Makefile.am +++ b/src/tapctl/Makefile.am @@ -18,7 +18,7 @@ # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. # -include $(top_srcdir)/build/ltrc.inc +include $(top_srcdir)/ltrc.inc MAINTAINERCLEANFILES =3D $(srcdir)/Makefile.in -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/501?usp=3Demail To unsubscribe, or for help writing mail filters, visit http://gerrit.openv= pn.net/settings Gerrit-Project: openvpn Gerrit-Branch: master Gerrit-Change-Id: Ib1a5c788269949d8de95d1da2cb0c32a65bf13f2 Gerrit-Change-Number: 501 Gerrit-PatchSet: 2 Gerrit-Owner: d12fk Gerrit-Reviewer: cron2 Gerrit-Reviewer: flichtenheld Gerrit-Reviewer: plaisthos Gerrit-Reviewer: stipa Gerrit-CC: openvpn-devel Gerrit-MessageType: merged --ZGpC7NXBRYc= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

cron2 submitted this change.

View Change

cmake: symlink whole build dir not just .json =
file

It turned out that symlinking compile_commands.json from the to= p level
source dir has some issues:
* file is not created on Window= s and symlinking may cause an error
* some IDEs create their own json = and error out b/c a file exists

Since clangd also looks for the json= in build/ directories by default,
we now symlink the whole build direct= ory instead, not just the json file.

This approach requires for the = existing build/ dir in the repo to
vanish. Luckily it only contains one = automake include file, which is
moved to the top level source dir.
Lastly, make this an opt-in feature, so that the default configurationof the buildsystem never causes a build failure because of this.

Ch= ange-Id: Ib1a5c788269949d8de95d1da2cb0c32a65bf13f2
Signed-off-by: Heiko = Hund <heiko@...2662...>
Acked-by: Gert Doering <gert@...1296...= >
Message-Id: <20240117134929.5317-1-gert@...1296...>
URL: h= ttps://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg28061.ht= ml
Signed-off-by: Gert Doering <gert@...1296...>
---
M .giti= gnore
M CMakeLists.txt
M Makefile.am
M README.cmake.md
D build/= Makefile.am
M configure.ac
R ltrc.inc
M src/openvpn/Makefile.amM src/openvpnmsica/Makefile.am
M src/openvpnserv/Makefile.am
M src/t= apctl/Makefile.am
11 files changed, 32 insertions(+), 25 deletions(-)
diff --git a/.gitignore b/.gitignore
index 4153a3e..92d6= 5bf 100644
--- a/.gitignore
+++ b/.gitignor= e
@@ -40,7 +40,7 @@
m4/ltversion.m4=
m4/lt~obsolete.m4

-compile_commands.json
+build
doc/openvpn-examples.5
doc/openvpn-examples.5.html
doc/openvpn.8
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 6a1895a..5e07d50 100644

--- a/CMakeLists.txt<= br>+++ b/CMakeLists.txt
@@ -43,9 +43,17 @@
= set(PLUGIN_DIR /usr/local/lib/openvpn/plugins CACHE FILEPATH "L= ocation of the plugin directory")

#= Create machine readable compile commands
-set(CMAKE_EXPORT_COMPILE_COMMANDS 1)
-file(CREATE_LINK ${CMAKE_CURRENT_BINARY_= DIR}/compile_commands.json
- ${CMAKE_CURRENT_SOURCE_DIR}/compile_commands.json SYM= BOLIC)
+option(ENABLE= _COMPILE_COMMANDS "Generate compile_commands.json and a symlink for cl= angd to find it" OFF)
+if (ENABLE_COMPILE_COMMANDS)
+ if (EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/build AND NOT IS= _SYMLINK ${CMAKE_CURRENT_SOURCE_DIR}/build)
+ message(FATAL_ERROR "The top level sou= rce directory contains a 'build' file or directory. Please remove o= r rename it. CMake creates a symlink with that name during build.")
+ endif()
= + set(CMAKE_EXPORT_COMPILE_C= OMMANDS 1)
+ add_c= ustom_target(
+ = symlink-build-dir ALL
+ ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_BINARY_DIR} = ${CMAKE_CURRENT_SOURCE_DIR}/build
+ )
+endif ()

# AddressSanitize - use CXX= =3Dclang++ CC=3Dclang cmake -DCMAKE_BUILD_TYPE=3Dasan to build with ASAN
set(CMAKE_C_FLAGS_ASAN
diff --git a/Makefile= .am b/Makefile.am
index 2305ab4..792588a 100644
<= span>--- a/Makefile.am

+++ b/Makefile.am
@@= -42,6 +42,7 @@
EXTRA_DIST =3D \
contrib= \
debug \
+ ltrc.inc \
CMakeLists.txt \
C= MakePresets.json \
config.h.cmake.in
@@ -= 53,7 +54,7 @@
config-version.h
endif


-SUBDIRS= =3D build distro include src sample doc tests
+SUBDIRS =3D distro include src sample doc tests<= /span>

dist_doc_DATA =3D \
RE= ADME \
diff --git a/README.cmake.md b/README.cmake.md
index d181b64..4f41c70 100644
--- a/README.cmake= .md
+++ b/README.cmake.md
@@ -135,3 +135,17= @@
The `unix-native` CMake preset is available for these = builds. This preset does
not require VCPKG and instead ass= umes all build-dependencies are provided by
the system nat= ively.
+
+Generating compile_commands.json=

+-------------------= -------------
+
+To have the CMake buildsy= stem generate compile_commands.json you can specify
+`-DENABLE_COMPILE_COMMANDS=3DON` on the c= ommand line or enable the CMake option
+another way you like. For supported generators the file = will then be created.
+Additionally, the buildsystem will create a symlink `build/` to the --pre= set
+build directory = that contains the generated JSON file. This is done so that
+clangd is able to find it.
+
+Enabling this option may cause an error on Wind= ows, since creating a symlink
+is a privileged operation there. If you enable Developer Mode for= the system,
+symlink= s can be created by regular users.
diff --git a/build/Makef= ile.am b/build/Makefile.am
deleted file mode 100644<= br>index e7cc4d8..0000000
--- a/build/Makefile.am
+++ /dev/null
@@ -1,15 +0,0 @@
-#

-# OpenVPN -- An application to securely tunnel IP networ= ks
-# over = a single UDP port, with support for SSL/TLS-based
-# session authentication and key ex= change,
-# = packet encryption, packet authentication, and
-# packet compression.
-#
-# Copyright (C) 2002-2023 OpenVPN Inc <sales@...515...&= gt;
-#
-
-MAINTAINERCLEANFILES =3D \
- $(srcdir)/Makefile.in
-
= -EXTRA_DIST =3D \
- ltr= c.inc
diff --git a/configure.ac b/configure.ac
index 3ad9f14..14f5be4 100644

--- a/configure.ac=
+++ b/configure.ac
@@ -1536,7 +1536,6 @@
AC_CONFIG_FILES([
Makefile
- build/Makefile distro/Makefile
distro/systemd/Makefile doc/Makefile
diff --git a/build/ltrc.inc b/ltrc.i= nc
similarity index 100%
rename from build/= ltrc.inc
rename to ltrc.inc
diff --git a/sr= c/openvpn/Makefile.am b/src/openvpn/Makefile.am
index b9539= 61..1dc1dda 100644
--- a/src/openvpn/Makefile.am
= +++ b/src/openvpn/Makefile.am
@@ -9,7 +9,7 @@<= br> # Copyright (C) 2006-2012 Alon Bar-Lev <alon.barlev@...277...= >
#

-include $(top_srcdir)/build/ltrc.inc
+include $(top_srcdir)/ltrc.inc<= br>
MAINTAINERCLEANFILES =3D \
$(= srcdir)/Makefile.in
diff --git a/src/openvpnmsica/Makefile.= am b/src/openvpnmsica/Makefile.am
index dc53f75..b10ce82 10= 0644
--- a/src/openvpnmsica/Makefile.am
+++= b/src/openvpnmsica/Makefile.am
@@ -18,7 +18,7 @@ # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#

-include $(top_srcdir)/build/ltrc.inc
+include $(top_srcdir)/ltrc.inc
=
MAINTAINERCLEANFILES =3D $(srcdir)/Makefile.in
diff --git a/src/openvpnserv/Makefile.am b/src/ope= nvpnserv/Makefile.am
index d8ba4eb..0c64cce 100644--- a/src/openvpnserv/Makefile.am
+++ b/src/openvpn= serv/Makefile.am
@@ -9,7 +9,7 @@
# Copyri= ght (C) 2006-2012 Alon Bar-Lev <alon.barlev@...277...>
#


= -include $(top_srcdir)/build/ltrc.inc
+include $(top_srcdir)/ltrc.inc
MAINTAINERCLEANFILES =3D $(srcdir)/Makefile.in

diff --git a/src/tapctl/Makefile.am b/src/tapctl/Makefile.am=
index 69ea161..4c2958b 100644
--- a/src/ta= pctl/Makefile.am
+++ b/src/tapctl/Makefile.am
@@ -18,7 +18,7 @@

# 51 Franklin Street, Fifth Floor, B= oston, MA 02110-1301 USA.
#

-include $(top_srcdir)/build/ltrc.i= nc

+include $(top_src= dir)/ltrc.inc

MAINTAINERCLEANFILES =3D $= (srcdir)/Makefile.in


= To view, visit change 501. To unsubscribe, or for help writing mail filters, vis= it settings.

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: Ib1a5c788269949d8de95d1da2cb= 0c32a65bf13f2
Gerrit-Change-Number: 501
Gerrit-PatchSet: 2
Gerrit-Owner: d12fk <heiko@...515...>
Gerrit-Reviewer: cron2 <gert@...1296...>=
Gerrit-Reviewer: flichtenheld <frank@...2716...= 1...>
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-Reviewer: stipa <lstipakov@...277...= >
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-MessageType: merged
--ZGpC7NXBRYc=--