Adjust CMake build behavior to match Qt project files #1636

cmuellner · 2024-11-06T04:20:26Z

I'm building qlcplus for Fedora using my own SPEC file, where I invoke qt-make (similar to the SPEC file in the qlcplus repo).
My assumption is, that the CMakeFile scripts should be the preferred build scripts, so there is a motivation to move there.
I tried to switch to cmake several times but always gave up as I ran into weird build issues.
This time, I decided to fix them.

I also switched my build from Qt5 to Qt6.

In total, I had to solve four issues, resulting in the four commits of this PR:

Hard-coded "qt5" in the PLUGINDIR path definition
Hard-coded Debian-style path in the LIBSDIR path definition
Missing build of the HTML docs
Installation of velleman library

One thing, that I did not fix is, that QLC+ can't be built out-of-tree because of generated header files (the include directory is relative to the source root and not the build root). I did not fix that, as it was not really a problem to do an in-tree build.

There is also a difference in the version-postfix of shared libraries (foo.so vs foo.so.1.0.0) between the CMakeFile scripts (creating foo.so) and the Qt project files (creating foo.so.1.0.0). I did not change that.

coveralls · 2024-11-06T04:32:30Z

coverage: 31.978%. remained the same
when pulling c5a5d5b on cmuellner:cmake-build-fedora
into 8a5a946 on mcallegari:master.

mcallegari · 2024-11-06T07:33:19Z

Hi, thanks for this but:

docs are no longer bundled to QLC+. Documentation is online here https://docs.qlcplus.org
velleman plugin is being phased out, so sooner or later it will be removed from build/installation

cmuellner · 2024-11-06T07:42:35Z

Hi, thanks for this but:

docs are no longer bundled to QLC+. Documentation is online here https://docs.qlcplus.org

Ok.

Should I add a commit to remove doc generation from the Qt project (resources/resources.pro includes SUBDIRS += docs)?

velleman plugin is being phased out, so sooner or later it will be removed from build/installation

I need to handle it somehow.
If it is built and installed, then rpmbuild complains if it is not packaged.
So, if I don't want it in the package, then I must prevent the build (that's what the commit does).

mcallegari · 2024-11-06T07:46:28Z

Should I add a commit to remove doc generation from the Qt project (resources/resources.pro includes SUBDIRS += docs)?

Yes please.

velleman plugin is being phased out, so sooner or later it will be removed from build/installation

I need to handle it somehow. If it is built and installed, then rpmbuild complains if it is not packaged. So, if I don't want it in the package, then I must prevent the build (that's what the commit does).

Up to you, but as I said, at some point I will remove it everywhere.

As for hardcoded 'qt5' paths I think there will be many more to fix. I checked also the qmltoqt6 branch and I think many changes are missing there too

cmuellner · 2024-11-06T08:32:55Z

As for hardcoded 'qt5' paths I think there will be many more to fix. I checked also the qmltoqt6 branch and I think many changes are missing there too

Most of which I have seen are gated by appimage.
For a UNIX/Linux build, I did not see any other qt5 issues.
Building and running a quick test with audio and video worked fine.

cmuellner · 2024-11-06T08:33:53Z

I've udpated the PR:

replace the commit that adds the docs to the CMake build with a commit that removes the docs from the Qt project

mcallegari · 2024-11-06T11:32:08Z

variables.cmake

@@ -89,7 +89,7 @@ if (WIN32)
 elseif (APPLE)
    set(LIBSDIR "Frameworks")
 elseif (UNIX)
-    set(LIBSDIR "lib/${CMAKE_C_LIBRARY_ARCHITECTURE}")
+    set(LIBSDIR "${CMAKE_INSTALL_LIBDIR}")


I need to check if this works on the Raspberry Pi and in general on Debian package creation

On Fedora this gives lib64.

The CMake implementation explicitly mentions that it works different for Debian and does so here: https://gitlab.kitware.com/cmake/cmake/-/blob/v3.26.4/Modules/GNUInstallDirs.cmake?ref_type=tags#L276

But yes, testing it is the best thing to do (I don't have a RasPi, so I cannot do that).

Just checked on Ubuntu

---> CMAKE_C_LIBRARY_ARCHITECTURE x86_64-linux-gnu ---> CMAKE_INSTALL_LIBDIR lib/x86_64-linux-gnu

Checked also on the Raspberry Pi

---> CMAKE_C_LIBRARY_ARCHITECTURE=aarch64-linux-gnu ---> CMAKE_INSTALL_LIBDIR=lib/aarch64-linux-gnu

So this change can actually work on Debian-like systems.

mcallegari · 2024-11-06T11:32:20Z

resources/resources.pro

@@ -1,6 +1,6 @@
 TEMPLATE = subdirs

-!qmlui: SUBDIRS += docs
+!qmlui:


Please remove the whole line

mcallegari · 2024-11-06T11:32:57Z

variables.cmake

@@ -289,7 +289,7 @@ elseif (UNIX)
    if (appimage)
        set(PLUGINDIR "../lib/qt5/plugins/qlcplus")


I'd port the change also to this line

Currently, we set a PLUGINDIR path that includes a hard-coded "qt5" subdir name in it. This obviously fails for Qt6. Luckily, we already have $QT_MAJOR_VERSION variables, which can be used to replace the hard-coded 5 by the actual version to build for. Signed-off-by: Christoph Müllner <[email protected]>

We already get a properly defined library directory path in the variable CMAKE_INSTALL_LIBDIR from invoking `include(GNUInstallDirs)` in the toplevel CMakeLists.txt. This is already addressing differences between different Linux distros. E.g., for Debian we get "lib/${CMAKE_LIBRARY_ARCHITECTURE}" and for Fedora we get "lib" or "lib64". So, let's use that variable. Signed-off-by: Christoph Müllner <[email protected]>

Docs are no longer bundled with QLC+. The CMakeLists.txt does not need to be adjusted as it does not include the corresponding subdirectory. Signed-off-by: Christoph Müllner <[email protected]>

On platforms other than Windows, libvelleman is just a mockup implementation for testing purposes. Therefore, the Qt-project file excludes this library from being installed on non-Windows platforms. Let's do the same in the CMakeLists.txt file. Signed-off-by: Christoph Müllner <[email protected]>

cmuellner · 2024-11-06T11:58:54Z

I've updated the PR as requested.

mcallegari · 2024-11-10T11:33:21Z

Merged, thanks 👍

ktdreyer · 2024-11-10T22:34:10Z

Hi @cmuellner, I'm testing building qlcplus for Fedora also. My latest Git snapshot is at https://copr.fedorainfracloud.org/coprs/ktdreyer/qlcplus/ , using the in-tree platforms/linux/qlcplus.spec file.

mcallegari · 2024-11-11T08:41:52Z

We've got Fedora builds since years here
https://build.opensuse.org/project/show/home:mcallegari79
triggered at every commit

cmuellner · 2024-11-11T09:28:37Z

Hi @cmuellner, I'm testing building qlcplus for Fedora also. My latest Git snapshot is at https://copr.fedorainfracloud.org/coprs/ktdreyer/qlcplus/ , using the in-tree platforms/linux/qlcplus.spec file.

I'm using my own spec file. You can find all details here: https://copr.fedorainfracloud.org/coprs/cmuellner/qlcplus/

ktdreyer · 2024-11-12T03:11:29Z

We've got Fedora builds since years here

Would you please consider updating to the latest Fedora versions? I see Fedora 37 and 38 there, and those are EOL.

cmuellner force-pushed the cmake-build-fedora branch from eb15ec0 to 0690e78 Compare November 6, 2024 08:31

mcallegari reviewed Nov 6, 2024

View reviewed changes

cmuellner added 4 commits November 6, 2024 12:58

resources: Remove docs subdirectory from Qt project

e08a62b

Docs are no longer bundled with QLC+. The CMakeLists.txt does not need to be adjusted as it does not include the corresponding subdirectory. Signed-off-by: Christoph Müllner <[email protected]>

cmuellner force-pushed the cmake-build-fedora branch from 0690e78 to c5a5d5b Compare November 6, 2024 11:58

mcallegari merged commit 9e273b5 into mcallegari:master Nov 10, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adjust CMake build behavior to match Qt project files #1636

Adjust CMake build behavior to match Qt project files #1636

cmuellner commented Nov 6, 2024

coveralls commented Nov 6, 2024 •

edited

Loading

mcallegari commented Nov 6, 2024 •

edited

Loading

cmuellner commented Nov 6, 2024

mcallegari commented Nov 6, 2024

cmuellner commented Nov 6, 2024

cmuellner commented Nov 6, 2024

mcallegari Nov 6, 2024

cmuellner Nov 6, 2024

mcallegari Nov 10, 2024 •

edited

Loading

mcallegari Nov 6, 2024

mcallegari Nov 6, 2024

cmuellner commented Nov 6, 2024

mcallegari commented Nov 10, 2024

ktdreyer commented Nov 10, 2024

mcallegari commented Nov 11, 2024

cmuellner commented Nov 11, 2024

ktdreyer commented Nov 12, 2024 •

edited

Loading

		@@ -289,7 +289,7 @@ elseif (UNIX)
		if (appimage)
		set(PLUGINDIR "../lib/qt5/plugins/qlcplus")

Adjust CMake build behavior to match Qt project files #1636

Adjust CMake build behavior to match Qt project files #1636

Conversation

cmuellner commented Nov 6, 2024

coveralls commented Nov 6, 2024 • edited Loading

mcallegari commented Nov 6, 2024 • edited Loading

cmuellner commented Nov 6, 2024

mcallegari commented Nov 6, 2024

cmuellner commented Nov 6, 2024

cmuellner commented Nov 6, 2024

mcallegari Nov 6, 2024

Choose a reason for hiding this comment

cmuellner Nov 6, 2024

Choose a reason for hiding this comment

mcallegari Nov 10, 2024 • edited Loading

Choose a reason for hiding this comment

mcallegari Nov 6, 2024

Choose a reason for hiding this comment

mcallegari Nov 6, 2024

Choose a reason for hiding this comment

cmuellner commented Nov 6, 2024

mcallegari commented Nov 10, 2024

ktdreyer commented Nov 10, 2024

mcallegari commented Nov 11, 2024

cmuellner commented Nov 11, 2024

ktdreyer commented Nov 12, 2024 • edited Loading

coveralls commented Nov 6, 2024 •

edited

Loading

mcallegari commented Nov 6, 2024 •

edited

Loading

mcallegari Nov 10, 2024 •

edited

Loading

ktdreyer commented Nov 12, 2024 •

edited

Loading