Build settings

[Nightwalker-87]

• Added new build configs for Travis CI
• Refactoring for cmake modules & settings
• Updated Travis build script
• GUI-Build on UNIX-based systems if GTK3 is detected
• [doc] Updated package requirements (GUI)
• Added CMAKEFLAGS and install target
• Updated CHANGELOG for upcoming release

Should see some testing if compilation also works well unter mac and win in real-world conditions. So far I did some runs on a debian bullseye system. GUI works well. Focus should be on correct package creation when reviewing and anything else that catches your eye of course.

The 3rd test (flash.c) still fails, as I haven't found the root of the problem yet.

Further I plan some more changes to the project structure, but I am waiting with this until several other issues have been addressed towards our upcoming release. Otherwise we would just run into unnecessary merge conflicts.

[chenguokai]

Edit: I made a mistake, the error is not caused for lack of gtk (cannot recognize gtk even if gtk3 is installed is still one possible issue here)

cmake fails at line 153:

-- The C compiler identification is AppleClang 11.0.0.11000033
-- Check for working C compiler: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/cc
-- Check for working C compiler: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/cc - works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Found Git: /usr/bin/git (found version "2.21.1 (Apple Git-122.3)") 
-- Performing Test C_SUPPORTS_STD_GNU11
-- Performing Test C_SUPPORTS_STD_GNU11 - Success
-- Performing Test C_SUPPORTS_WALL
-- Performing Test C_SUPPORTS_WALL - Success
-- Performing Test C_SUPPORTS_WEXTRA
-- Performing Test C_SUPPORTS_WEXTRA - Success
-- Performing Test C_SUPPORTS_WSHADOW
-- Performing Test C_SUPPORTS_WSHADOW - Success
-- Performing Test C_SUPPORTS_D_FORTIFY_SOURCE_2
-- Performing Test C_SUPPORTS_D_FORTIFY_SOURCE_2 - Success
-- Performing Test C_SUPPORTS_FSTRICT_ALIASING
-- Performing Test C_SUPPORTS_FSTRICT_ALIASING - Success
-- Performing Test C_SUPPORTS_WUNDEF
-- Performing Test C_SUPPORTS_WUNDEF - Success
-- Performing Test C_SUPPORTS_WFORMAT
-- Performing Test C_SUPPORTS_WFORMAT - Success
-- Performing Test C_SUPPORTS_WFORMAT_SECURITY
-- Performing Test C_SUPPORTS_WFORMAT_SECURITY - Success
-- Performing Test C_SUPPORTS_WMAYBE_UNINITIALIZED
-- Performing Test C_SUPPORTS_WMAYBE_UNINITIALIZED - Failed
-- Performing Test C_SUPPORTS_WMISSING_VARIABLE_DECLARATIONS
-- Performing Test C_SUPPORTS_WMISSING_VARIABLE_DECLARATIONS - Success
-- Performing Test C_SUPPORTS_WSHORTEN_64_TO_32
-- Performing Test C_SUPPORTS_WSHORTEN_64_TO_32 - Success
-- Performing Test C_SUPPORTS_WIMPLICIT_FUNCTION_DECLARATION
-- Performing Test C_SUPPORTS_WIMPLICIT_FUNCTION_DECLARATION - Success
-- Performing Test C_SUPPORTS_WREDUNDANT_DECLS
-- Performing Test C_SUPPORTS_WREDUNDANT_DECLS - Success
-- Performing Test C_SUPPORTS_FPIC
-- Performing Test C_SUPPORTS_FPIC - Success
-- Performing Test C_SUPPORTS_O2
-- Performing Test C_SUPPORTS_O2 - Success
-- Performing Test C_SUPPORTS_WERROR
-- Performing Test C_SUPPORTS_WERROR - Success
-- Found Libusb: /opt/local/lib/libusb-1.0.a  
-- Looking for sys/mman.h
-- Looking for sys/mman.h - found
-- Looking for unistd.h
-- Looking for unistd.h - found
-- Looking for __stack_chk_fail in ssp
-- Looking for __stack_chk_fail in ssp - not found
-- STLINK_LIB_SHARED: stlink
-- PROJECT_VERSION_MAJOR: 
-- VERSION: ..
CMake Error at CMakeLists.txt:153 (set_target_properties):
  set_target_properties called with incorrect number of arguments.


-- gtk not found!
-- Manpage generation disabled
-- Configuring incomplete, errors occurred!
See also "/Users/cgk/Downloads/stlink-build-settings/build/Release/CMakeFiles/CMakeOutput.log".
See also "/Users/cgk/Downloads/stlink-build-settings/build/Release/CMakeFiles/CMakeError.log".
make: *** [build/Release] Error 1

This problem occurs only when I build with from the zip file downloaded on the web interface. The build succeed with a git cloned one. Maybe we should add a doc for this or (if possible) throw a warning in cmake.

Original wrong idea

My local test failed for lack of gtk.
I suggest do not enable gtk-based GUI by default, at least for macOS.
GTK is not native in macOS. Also, GTK on macOS only officially support macOS 10.10 and later(In practice, gtk3 builds on 10.7 and later), which would force me to drop support for support starting from 10.6.

If the GUI is set to optional, a GUI variant can be added to MacPorts Portfile, which will provide the interface for 10.7 and later.

[Nightwalker-87]

This may be an undiscovered older problem...

We can make gtk3 an requirement for installations via brew and Macports which then would allow mac users to make use of this feature as well. As far as I can see there is no mention related to the GUI for macOS in our project documentation at all. To me it is not necessary to provide an additional package for the gui on linux either. So my suggestion on this is to include the gui into the main package and to install it by default if gtk can be retrieved automatically from a repo and skip it if this is not possible (e.g. on stand alone installations).

[Nightwalker-87]

CMake Error at CMakeLists.txt:153 (set_target_properties):
set_target_properties called with incorrect number of arguments.

This should not fail really. I think it is a problem with reading the project version number when git is not present. That would also explain why this only happens when downloading the zip archive.

[Nightwalker-87]

@chenguokai: I found that some necessary cases were not addressed in the workflow of the version.cmake module. Please retry.

[chenguokai]

Build succeeded without git, nice work!

But I still cannot figure out why cmake failed to recognize either gtk2 or gtk3 which has been installed by MacPorts. Confirmed that both headers and binary dynamic libs are present.

[Nightwalker-87]

One reason for that seems to be in /CMakeLists.txt:

if (NOT APPLE AND NOT WIN32 AND NOT CMAKE_CROSSCOMPILING)
    find_package(PkgConfig)
    pkg_check_modules(gtk gtk+-3.0)
endif ()

Thus macOS is always excluded from GUI builds and the detection in /src/stlink-gui/CMakeLists.txt does not help as gtk_FOUND has not seen any result from the previous check:

if (NOT gtk_FOUND)
    message(STATUS "gtk not found!")
    return()                         # no GTK present => no GUI build
endif ()

[Nightwalker-87]

@chenguokai: Here are some more improvements: We query for GTK3 on all unix-based systems. If cmake does not find it, there will be no compilation for the GUI. I've updated the related documentation as well, so have a short look at that first. Hence I expect the GUI to compile flawlessly on macOS now, if there is no mistake.
Please give it another try.

@grevaillot and @chenguokai you may finally review this now. I'm not planning any extra work on this PR apart from necessary fixes, if needed.

[chenguokai]

Works so well!

[martonmiklos]

Managed to build it under 18.04 Ubuntu.