Refactor qmk_install.sh #10681

fauxpark · 2020-10-18T04:41:48Z

Description

Splits each platform/distro out into its own file, which qmk_install.sh simply sources before running _qmk_install_prepare and (if successful) then _qmk_install.

Will need a bit of testing...

Types of Changes

Issues Fixed or Closed by This PR

Checklist

My code follows the code style of this project: C, Python
I have read the PR Checklist document and have made the appropriate changes.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

fauxpark · 2020-10-19T12:48:11Z

util/install/opensuse.sh

+#!/bin/bash
+
+_qmk_install_prepare() {
+    case $(grep ID /etc/os-release) in
+        *15.1*)
+            REPO_RELEASE=Leap_15.1;;
+        *15.2*)
+            REPO_RELEASE=Leap_15.2;;
+        *)
+            #REPO_RELEASE=Tumbleweed;;
+            echo "ERROR: Tumbleweed is currently not supported."
+            exit 1
+    esac
+
+    sudo zypper addrepo https://download.opensuse.org/repositories/devel:gcc/openSUSE_$REPO_RELEASE/devel:gcc.repo
+    sudo zypper addrepo https://download.opensuse.org/repositories/hardware/openSUSE_$REPO_RELEASE/hardware.repo
+    sudo zypper --gpg-auto-import-keys refresh
+}
+
+_qmk_install() {
+    echo "Installing dependencies"
+
+    sudo zypper install -y \
+        make clang gcc unzip wget zip \
+        python3-pip \
+        cross-avr-binutils cross-avr-gcc8 avr-libc \
+        cross-arm-binutils cross-arm-none-gcc8 cross-arm-none-newlib-devel \
+        avrdude dfu-programmer dfu-util
+
+    python3 -m pip install --user -r $QMK_FIRMWARE_DIR/requirements.txt
+}


There is no Tumbleweed directory for devel:gcc, and cross-arm-none-gcc8 throws a bunch of linker errors on Leap... so OpenSUSE support is broken at this time. If any OpenSUSE user is able to provide a fix (or better yet, fix the packages and repos), it would be much appreciated!

Would it be worth grabbing the official ARM toolchain in this circumstance, then?
https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads

I'd kinda like to avoid another ~/qmk_utils folder if at all possible, considering you have to modify the .bashrc to add it to PATH (and some users may not be running bash), and then a new terminal must be opened before qmk doctor displays the correct results. Preferably the already existing package should be fixed.

fauxpark · 2020-10-19T16:15:46Z

Testing Solus now - @chax is there a particular reason the AVR and ARM toolchain is not symlinked into /usr/bin? It would be preferable not to have to ask users to source a script in order to compile, it should Just Work. (especially since qmk doctor will check for the presence and versions of the GCCs after qmk_install.sh runs, if installing from the CLI)

chax · 2020-10-19T16:33:43Z

It should "just work" if you open new terminal, since those scripts are automatically sourced on every new terminal session. But for current terminal, if you don't source them manually, it won't work. The reason AVR and ARM toolchain are not in standard PATH is that Solus core team didn't want those to be in core part of the system, but installed in separate (custom) path. Maybe you can source them automatically upon completed installation, therefore you won't need to warn user to do that.

Since gcc is not guaranteed to be installed until after that point

fauxpark · 2020-10-20T02:39:03Z

The reason AVR and ARM toolchain are not in standard PATH is that Solus core team didn't want those to be in core part of the system, but installed in separate (custom) path.

I can understand having the toolchains installed to a separate place, but my question is why are they not symlinked into /usr/bin? Note that these binaries will not conflict with any others as they are prefixed with the target (eg. avr and arm-none-eabi), so it is perfectly safe to have them there.

Unfortunately sourcing the scripts automatically during _qmk_install does not work, presumably because everything is basically run in a subshell.

chax · 2020-10-20T10:26:13Z

Ahh right, i think you're right, i forgot when you run script as a separate process, sourcing environment variables affect only that process and not the terminal session from which script is run. I can talk with Solus core team about symlinks but i think they have the same stance towards symlinks as if it was just the binaries, but maybe they changed their mind a bit in last two years. We'll try to find some solution here, but for now, user must source them themselves manually.

fauxpark · 2020-10-20T11:03:24Z

util/install/sabayon.sh

+#!/bin/bash
+
+_qmk_install() {
+    echo "Installing dependencies"
+
+    sudo equo install \
+        app-arch/unzip app-arch/zip net-misc/wget sys-devel/clang sys-devel/gcc sys-devel/crossdev \
+        dev-lang/python \
+        dev-embedded/avrdude dev-embedded/dfu-programmer app-mobilephone/dfu-util
+
+    sudo crossdev -s4 --stable --g \<9 --portage --verbose --target avr
+    sudo crossdev -s4 --stable --g \<9 --portage --verbose --target arm-none-eabi
+
+    python3 -m pip install --user -r $QMK_FIRMWARE_DIR/requirements.txt
+}


After switching to the sabayonlinux.org repo (rather than sabayon-weekly) I was able to update the distro - for some reason the weekly repo wanted to upgrade mesa to a version that was not in any of the mirrors.
Now, the crossdev commands fail with:

/usr/bin/crossdev: line 1019: multilib_env: command not found * error: could not load multilib settings for HCHOST

🤷

fauxpark · 2020-10-27T06:40:24Z

@petejohanson @csssuf would you mind testing/reviewing the FreeBSD and Gentoo scripts, respectively?

I think in the FreeBSD case, we should not attempt to do anything unless sudo is installed, or let it error out.

util/install/gentoo.sh

csssuf · 2020-10-27T21:02:00Z

@fauxpark From a quick read, Gentoo looks good to me other than one small comment - if you want to be extra sure I can give it a proper test later today or tomorrow.

fauxpark · 2020-10-28T05:22:43Z

@csssuf That'd be helpful, yeah. In particular I suspect the read prompt may not actually pause when qmk_install.sh is run via qmk setup.
It could just be a Windows thing though; I've only so far noticed it in the driver installation prompt for MSYS2, which has since been removed in favour of installing them anyway.

tzarc

Restructuring LGTM, not executed any of them but the concept looks sound.

fauxpark · 2020-11-24T01:30:20Z

@csssuf did you get time to test this?

And @chax any luck with the Solus stuff?

I think either way, this is probably good to merge as is, and we can work out the kinks for the less popular distros later.

fauxpark added enhancement needs testing labels Oct 18, 2020

fauxpark requested a review from a team October 18, 2020 04:41

Refactor qmk_install.sh

921db94

fauxpark force-pushed the qmk-install-refactor branch from b6cd5b9 to 921db94 Compare October 18, 2020 11:13

fauxpark added 3 commits October 18, 2020 23:00

Fix some dumb typos

fab8bee

Update docs to not prompt

e39a610

Update docs for Void Linux

14f0d0a

github-actions bot added core documentation labels Oct 18, 2020

zvecr removed the core label Oct 18, 2020

github-actions bot added the core label Oct 18, 2020

Update OpenSUSE script

136673f

fauxpark commented Oct 19, 2020

View reviewed changes

Tweak Arch script

f118688

Move bootloadHID installation after distro-specific installation

5d95abb

Since gcc is not guaranteed to be installed until after that point

fauxpark force-pushed the qmk-install-refactor branch from 6e049e7 to 5d95abb Compare October 20, 2020 02:28

Tweak Solus script

e2d6802

fauxpark commented Oct 20, 2020

View reviewed changes

Tweak Sabayon script

91478aa

csssuf reviewed Oct 27, 2020

View reviewed changes

util/install/gentoo.sh Outdated Show resolved Hide resolved

Update Python version for Gentoo script

7a49b2a

drashna approved these changes Oct 28, 2020

View reviewed changes

tzarc approved these changes Nov 10, 2020

View reviewed changes

drashna approved these changes Nov 25, 2020

View reviewed changes

Erovia approved these changes Nov 26, 2020

View reviewed changes

Erovia merged commit c21d5a0 into qmk:master Nov 26, 2020

fauxpark deleted the qmk-install-refactor branch November 26, 2020 14:39

xgnxs pushed a commit to xgnxs/qmk_firmware that referenced this pull request Jan 9, 2021

Refactor qmk_install.sh (qmk#10681)

c1585cd

drashna pushed a commit to zsa/qmk_firmware that referenced this pull request Jan 13, 2021

Refactor qmk_install.sh (qmk#10681)

546a0e1

BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024

Refactor qmk_install.sh (qmk#10681)

43e1c32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor qmk_install.sh #10681

Refactor qmk_install.sh #10681

fauxpark commented Oct 18, 2020 •

edited

Loading

fauxpark Oct 19, 2020

tzarc Oct 23, 2020

fauxpark Oct 23, 2020 •

edited

Loading

fauxpark commented Oct 19, 2020 •

edited

Loading

chax commented Oct 19, 2020

fauxpark commented Oct 20, 2020 •

edited

Loading

chax commented Oct 20, 2020

fauxpark Oct 20, 2020

fauxpark commented Oct 27, 2020

csssuf commented Oct 27, 2020

fauxpark commented Oct 28, 2020

tzarc left a comment

fauxpark commented Nov 24, 2020

Refactor qmk_install.sh #10681

Refactor qmk_install.sh #10681

Conversation

fauxpark commented Oct 18, 2020 • edited Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

fauxpark Oct 19, 2020

Choose a reason for hiding this comment

tzarc Oct 23, 2020

Choose a reason for hiding this comment

fauxpark Oct 23, 2020 • edited Loading

Choose a reason for hiding this comment

fauxpark commented Oct 19, 2020 • edited Loading

chax commented Oct 19, 2020

fauxpark commented Oct 20, 2020 • edited Loading

chax commented Oct 20, 2020

fauxpark Oct 20, 2020

Choose a reason for hiding this comment

fauxpark commented Oct 27, 2020

csssuf commented Oct 27, 2020

fauxpark commented Oct 28, 2020

tzarc left a comment

Choose a reason for hiding this comment

fauxpark commented Nov 24, 2020

fauxpark commented Oct 18, 2020 •

edited

Loading

fauxpark Oct 23, 2020 •

edited

Loading

fauxpark commented Oct 19, 2020 •

edited

Loading

fauxpark commented Oct 20, 2020 •

edited

Loading