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 <heiko@ist.eigentlich.net>
Acked-by: Gert Doering <gert@greenie.muc.de>
Message-Id: <
20240117134929.5317-1-gert@greenie.muc.de>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg28061.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>
m4/ltversion.m4
m4/lt~obsolete.m4
-compile_commands.json
+build
doc/openvpn-examples.5
doc/openvpn-examples.5.html
doc/openvpn.8
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 SYMBOLIC)
+option(ENABLE_COMPILE_COMMANDS "Generate compile_commands.json and a symlink for clangd 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 source directory contains a 'build' 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} ${CMAKE_CURRENT_SOURCE_DIR}/build
+ )
+endif ()
# AddressSanitize - use CXX=clang++ CC=clang cmake -DCMAKE_BUILD_TYPE=asan to build with ASAN
set(CMAKE_C_FLAGS_ASAN
EXTRA_DIST = \
contrib \
debug \
+ ltrc.inc \
CMakeLists.txt \
CMakePresets.json \
config.h.cmake.in
config-version.h
endif
-SUBDIRS = build distro include src sample doc tests
+SUBDIRS = distro include src sample doc tests
dist_doc_DATA = \
README \
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 specify
+`-DENABLE_COMPILE_COMMANDS=ON` on the command 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 --preset
+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 symlink
+is a privileged operation there. If you enable Developer Mode for the system,
+symlinks can be created by regular users.
+++ /dev/null
-#
-# 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 <sales@openvpn.net>
-#
-
-MAINTAINERCLEANFILES = \
- $(srcdir)/Makefile.in
-
-EXTRA_DIST = \
- ltrc.inc
AC_CONFIG_FILES([
Makefile
- build/Makefile
distro/Makefile
distro/systemd/Makefile
doc/Makefile
# Copyright (C) 2006-2012 Alon Bar-Lev <alon.barlev@gmail.com>
#
-include $(top_srcdir)/build/ltrc.inc
+include $(top_srcdir)/ltrc.inc
MAINTAINERCLEANFILES = \
$(srcdir)/Makefile.in
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
-include $(top_srcdir)/build/ltrc.inc
+include $(top_srcdir)/ltrc.inc
MAINTAINERCLEANFILES = $(srcdir)/Makefile.in
# Copyright (C) 2006-2012 Alon Bar-Lev <alon.barlev@gmail.com>
#
-include $(top_srcdir)/build/ltrc.inc
+include $(top_srcdir)/ltrc.inc
MAINTAINERCLEANFILES = $(srcdir)/Makefile.in
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
-include $(top_srcdir)/build/ltrc.inc
+include $(top_srcdir)/ltrc.inc
MAINTAINERCLEANFILES = $(srcdir)/Makefile.in