Serial-Studio was upstreamed to MSYS2 repositories

[umarcor]

Earlier today, a PKGBUILD recipe for Serial-Studio was accepted in msys2/MINGW-packages) (see msys2/MINGW-packages#7682 and mingw-w64-serial-studio).

The package was already built for MINGW32 and MINGW64. Those are available at staging-mingw. Most impatient users can download the mingw-w64-*serial-studio-*.zst files and install them with pacman -U *.zst. In the following days, maintainers will sign and upload them to the pacman repositories.

Serial-Studio was included in group mingw-w64-*-eda, which includes multiple tools/projects related to electronic design automation. See hdl.github.io/MINGW-packages for further details.

@alex-spataru, as you can see in https://github.com/msys2/MINGW-packages/blob/master/mingw-w64-serial-studio/PKGBUILD#L36, I "had to" install the binary directly, since I couldn't find a make install target. Is that correct? Shall we change it for future releases?

BTW, congrats for this nice looking and offensively easy to build project! 😄

[alex-spataru]

Hi @umarcor, first of all, a big thank you for creating the PKGBUILD recipe!

A make install target can be easily generated by modifying the Serial-Studio.pro file (for example, here are the make install commands for GNU/Linux).

I think that we can easily do something similar for the win32* target. I just need to know what values you need for target.path and license.path.

Greetings!

[alex-spataru]

Update, I added the following config for win32 in the qmake project:

win32* {
    TARGET = SerialStudio
    RC_FILE = deploy/windows/resources/info.rc
    
    # MSYS2 integration
    target.path = /bin
    license.path = /share/licenses/
    license.files += LICENSE.md
    INSTALLS += target license
}

Please let me know if this configuration allows you to run make install and obtain the appropriate results.

[umarcor]

@alex-spataru you were so fast! Thanks for your quick and proactive reaction!

I created #9 for iterating faster on this. You should be able to push to that branch (or create another one based on that), if you want.

It seems that the new make install target does work, however, it is ignoring the PREFIX and DESTDIR variables, which are very used by packagers. See https://github.com/Serial-Studio/Serial-Studio/pull/9/files#diff-57c1a8b93f074586ac89e2e3f65f87bc428edc786ae3ca176cba639141dcf95fR25 and https://github.com/Serial-Studio/Serial-Studio/pull/9/files#diff-57c1a8b93f074586ac89e2e3f65f87bc428edc786ae3ca176cba639141dcf95fR35. As a result, install is placing the binaries in the system, and not in the desired location, and the resulting package is empty. See https://github.com/umarcor/Serial-Studio/runs/1732014741?check_suite_focus=true#step:5:1164 and https://github.com/umarcor/Serial-Studio/runs/1732043616?check_suite_focus=true#step:5:18. Compare with the "manual" procedure: https://github.com/umarcor/Serial-Studio/runs/1731960761?check_suite_focus=true#step:5:24.

Therefore, I think that just honouring PREFIX and DESTDIR would probably fix the issue. However, I am not sure about $(DESTDIR)/$(PREFIX)/bin and $(DESTDIR)/$(PREFIX)/share/licenses being the desirable paths for all win32* targets. On the one hand, in the PKGBUILD recipes, the license is copied to $(DESTDIR)/$(PREFIX)/share/licenses/serial-studio/. On the other hand, non MSYS2 builds on Windows might require other locations.

[umarcor]

In order to have some reference, I found that the fritzing package uses Qt5 (qmake) too, and there is a patch for dealing with these installation paths. See:

• https://github.com/msys2/MINGW-packages/blob/master/mingw-w64-fritzing/PKGBUILD
• https://github.com/msys2/MINGW-packages/blob/master/mingw-w64-fritzing/0003-qmake-fixes-for-mingw.patch

It seems that if(unix:!macx)|mingw, unix|mingw, win32:!mingw, etc. can be used for telling apart MSYS2 (mingw) targets from win32 targets.

[alex-spataru]

Hi @umarcor,

I'll check what can be done so that qmake takes into account the PREFIX and DESTDIR variables. It should be possible because on Linux these variables are honored for app image generation.

Regarding:

However, I am not sure about $(DESTDIR)/$(PREFIX)/bin and $(DESTDIR)/$(PREFIX)/share/licenses being the desirable paths for all win32* targets.

And:

It seems that if(unix:!macx)|mingw, unix|mingw, win32:!mingw, etc. can be used for telling apart MSYS2 (mingw) targets from win32 targets.

I think that adding specific qmake instructions for MinGW is the correct approach, since I am using MSVC for the binaries that I distribute through GitHub releases. I will do some research, modify Serial-Studio.pro and notify you as soon as I come up with something.

Greetings!

[alex-spataru]

@umarcor I added the following code in Serial-Studio.pro:

#-------------------------------------------------------------------------------
# MSYS2 integration
#-------------------------------------------------------------------------------

win32-g++ {
    target.path = $$(pkgdir)$$(MINGW_PREFIX)/bin
    license.path = $$(pkgdir)$$(MINGW_PREFIX)/share/licenses/$$(_realname)
    license.files += LICENSE.md
    INSTALLS += target license
}

This only affects Windows builds using g++ (basically just MinGW builds AFAIK). You can modify freely that configuration, since I use MSVC for deploying the app (and I don't use make install for creating the NSIS installer).

In this configuration, $$(pkgdir), $$(MINGW_PREFIX) and $$(_realname) are pulled directly from the env. variables, please let me know if this helps you.

[umarcor]

Hi @alex-spataru! Thanks again for your quick reaction.

I did try the modifications you did, but it does not work as expected. There are two functions in the build:

• build, where qmake is executed and pkgdir is not defined.
• package, where make is executed and pkgdir is defined.

Therefore, your proposed code is interpreted as follows:

win32-g++ {
    target.path = $$(MINGW_PREFIX)/bin
    license.path = $$(MINGW_PREFIX)/share/licenses/$$(_realname)
    license.files += LICENSE.md
    INSTALLS += target license
}

And the result is: https://github.com/Serial-Studio/Serial-Studio/runs/1796167547?check_suite_focus=true#step:5:1161

==> Starting package()...
make -f Makefile.Release install
make[1]: Entering directory '/d/a/Serial-Studio/Serial-Studio/msys2/src/build'
cp -f release/SerialStudio.exe D:/a/_temp/msys/msys64/mingw64/bin/SerialStudio.exe
D:/a/_temp/msys/msys64/mingw64/bin/qmake.exe -install qinstall D:/a/Serial-Studio/Serial-Studio/LICENSE.md D:/a/_temp/msys/msys64/mingw64/share/licenses/LICENSE.md
make[1]: Leaving directory '/d/a/Serial-Studio/Serial-Studio/msys2/src/build'

By looking at the generated makefile:

install_target: first FORCE
	@test -d C:$(INSTALL_ROOT:@msyshack@%=%)/msys64/mingw64/bin || mkdir -p C:$(INSTALL_ROOT:@msyshack@%=%)/msys64/mingw64/bin
	-$(INSTALL_FILE) $(DESTDIR_TARGET) C:$(INSTALL_ROOT:@msyshack@%=%)/msys64/mingw64/bin/$(TARGET)

So, make INSTALL_ROOT="$pkgdir" does neither work.

I asked for help in the MSYS2 community. Hope someone can provide some guidelines.

[umarcor]

@alex-spataru, I think I found a solution by following the advice in the MSYS2 chat. Please, see #9. Precisely 8484157. Let me know if you can cherry-pick it.

[alex-spataru]

@umarcor Looks good to me! I just executed git cherry-pick with your repo. Honestly, I just learned about the existence of that command right now. I still do most of my work with the basic git pull, push and commit commands and do merges with the GitHub UI 🤣.

Anyways, the commands that I executed where:

git remote add other https://github.com/umarcor/Serial-Studio
git fetch other
git checkout master
git cherry-pick 8484157

Please let me know if I executed the right commands.

[umarcor]

@alex-spataru that's correct! I rebased and pushed again for ensuring that everything works as expected. I got the arbitrary Bad address issue, but other than that it looks good: https://github.com/umarcor/Serial-Studio/actions/runs/535908540 Thanks!

[alex-spataru]

@umarcor Perfect! The workflow looks a lot better with your changes. Should I mark your PR as 'ready for review'?