libratbag: init at v0.9.903 #46274

mvnetbiz · 2018-09-07T03:46:31Z

Motivation for this change

Libratbag is a daemon and utility for configuring DPI, buttons, etc. of programmable gaming mice.

Things done

Added package for libratbag and service module ratbagd.
Added piper: gtk frontend app for ratbagctl

Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
Built on platform(s)
- NixOS
- macOS
- other Linux distributions
Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
Tested execution of all binary files (usually in ./result/bin/)
Determined the impact on package closure size (by running nix path-info -S before and after)
Fits CONTRIBUTING.md.

jtojnar · 2018-09-08T22:07:30Z

See also #35516

pkgs/os-specific/linux/libratbag/default.nix

jtojnar · 2018-09-08T21:58:56Z

pkgs/os-specific/linux/libratbag/default.nix

+  };
+
+  nativeBuildInputs = [
+    (python3.withPackages (ps: with ps; [ evdev pygobject3 ]))


This should be moved to buildInputs.

If this is moved to buildInputs, the patch shebangs for "ratbagctl" gives the wrong python, and program fails because it can't import the right modules. This seemed like the wrong place to put it based on nixos manual's description of the different build inputs, but I am not sure how to get around that.

The issue is probably that meson propagates its own python, it is going to be fixed in #46020. For now, could you add a TODO comment saying that Python should go to buildInputs once #46020 is merged?

jtojnar · 2018-09-08T22:02:08Z

nixos/modules/services/hardware/ratbagd.nix

+    # Give users access to the "ratbagctl" tool
+    environment.systemPackages = [ pkgs.libratbag ];
+
+    systemd.services.ratbagd = {


You should be able to use systemd.packages = [ pkgs.libratbag ];

pkgs/os-specific/linux/libratbag/default.nix

mvnetbiz · 2018-09-13T05:09:35Z

I've included your suggestions, thanks.

jtojnar · 2018-09-13T12:12:44Z

nixos/modules/services/hardware/ratbagd.nix

+    environment.systemPackages = [ pkgs.libratbag ];
+
+    systemd.packages = [ pkgs.libratbag ];
+    systemd.services.ratbagd = {


Why did you keep this? It should already be specified in the service file in the package, which is installed by the systemd.packages option.

I couldn't figure out of that actually used the packages own unit file. It didn't seem to work for me when I removed my own definition. Is there a way to point it to where the build outputs it?

It does, only the servcie file does not have wantedBy. You can do systemd.services.ratbagd.wantedBy = [ "multi-user.target" ];, which will add the key to the override.

I wonder why the upstream service does not have that, though – maybe the daemon is supposed to be launched using a different method.

jtojnar · 2018-09-13T12:13:55Z

Do you plan to package piper as well? It would be nice to have some app to test if this is working.

mvnetbiz · 2018-09-14T08:13:35Z

I was going to do that too. Would that be a separate PR? Libratbag package does have a command line that I have tested with my Logitech G403.

jtojnar · 2018-09-14T11:38:47Z

For closely related packages like this, a single PR is fine.

mvnetbiz · 2018-09-18T07:26:03Z

I was looking at packaging piper and got stuck on something. The piper application is a python script that includes a import like "import piper.application" in itself. Since meson propagates the python from the nativebuildinputs into this piper script, the python env it runs in does not include the piper package.
Do I need to make a python module in nix for piper, and then include a python with piper in the buildinputs and patch the script after build to use that? I am a bit lost here :(

jtojnar · 2018-09-18T08:02:31Z

I am aware of the issue and it will be fixed in the next meson release (#46020). At the moment we try to fix this by adding python before meson in nativeBuildInputs but I am not sure 100% sure it will work for Python programs. What expression do you have?

mvnetbiz · 2018-09-18T08:30:09Z

Pushed my expression for piper

mvnetbiz · 2018-09-18T08:33:16Z

I patched out 2 lines from meson.build. One is it can't verify python gobject is installed. This must have something to do with pkg-config? I don't know how any of that works. And the other line includes a script that does something with gtk-update-icon-cache which fails. I think we don't need icon cache in the store anyways?

jtojnar · 2018-09-18T08:57:15Z

Yep, only packages listed in build inputs get added to the PKG_CONFIG_PATH. You can add pygobject there.

Right, gtk-update-icon-cache is not good for us, we have hicolor-icon-theme setup hook removing the generated cache file for us, though, maybe we should still run the file in case the glib-compile-schemas is ever uncommented. See, for example, this for how to make it runnable:

nixpkgs/pkgs/desktops/gnome-3/apps/gnome-calendar/default.nix

Lines 29 to 32 in 874b045

    
             postPatch = '' 
        
               chmod +x meson_post_install.py # patchShebangs requires executable file 
        
               patchShebangs meson_post_install.py 
        
             '';

mvnetbiz · 2018-09-20T07:51:08Z

Ok I've fixed up piper, using the python builder now. It works with my logitech mouse.

mvnetbiz · 2018-09-20T07:52:06Z

Is there anything else I need to do? Should I squash commits or anything?

jtojnar · 2018-09-20T09:34:53Z

Each package should be in a separate commit; other than that, it looks good.

Add package libratbag and service module ratbagd Libratbag contains ratbagd daemon and ratbagctl cli to configure buttons, dpi, leds, etc. of gaming mice. Add mvnetbiz to maintainers.

Add package piper. Piper is a gtk frontend application for ratbagctl to configure gaming mice.

mvnetbiz · 2018-09-21T09:26:16Z

Ok thanks. I have split the commits and updated the PR description to include piper.

jtojnar · 2018-09-21T20:49:12Z

Thank you.

GrahamcOfBorg added 6.topic: nixos 8.has: module (update) 8.has: package (new) 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Sep 7, 2018

jtojnar requested changes Sep 8, 2018

View reviewed changes

mvnetbiz force-pushed the libratbag branch from 6ae0918 to c4f465c Compare September 10, 2018 06:02

jtojnar reviewed Sep 13, 2018

View reviewed changes

mvnetbiz force-pushed the libratbag branch from 8f47a29 to 3044800 Compare September 20, 2018 08:14

mvnetbiz added 2 commits September 21, 2018 02:13

libratbag: init at v0.9.903

9a859fb

Add package libratbag and service module ratbagd Libratbag contains ratbagd daemon and ratbagctl cli to configure buttons, dpi, leds, etc. of gaming mice. Add mvnetbiz to maintainers.

piper: init at 0.2.902

78f1715

Add package piper. Piper is a gtk frontend application for ratbagctl to configure gaming mice.

mvnetbiz force-pushed the libratbag branch from 3044800 to 78f1715 Compare September 21, 2018 09:22

jtojnar merged commit 93408ae into NixOS:master Sep 21, 2018

mvnetbiz deleted the libratbag branch November 28, 2020 03:24

Janik-Haag added the 12. first-time contribution label Jun 12, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

libratbag: init at v0.9.903 #46274

libratbag: init at v0.9.903 #46274

mvnetbiz commented Sep 7, 2018 •

edited

jtojnar commented Sep 8, 2018

jtojnar Sep 8, 2018

mvnetbiz Sep 10, 2018 •

edited

jtojnar Sep 10, 2018

jtojnar Sep 8, 2018

mvnetbiz commented Sep 13, 2018

jtojnar Sep 13, 2018 •

edited

mvnetbiz Sep 14, 2018

jtojnar Sep 14, 2018

jtojnar commented Sep 13, 2018

mvnetbiz commented Sep 14, 2018

jtojnar commented Sep 14, 2018

mvnetbiz commented Sep 18, 2018

jtojnar commented Sep 18, 2018

mvnetbiz commented Sep 18, 2018

mvnetbiz commented Sep 18, 2018

jtojnar commented Sep 18, 2018

mvnetbiz commented Sep 20, 2018

mvnetbiz commented Sep 20, 2018

jtojnar commented Sep 20, 2018 •

edited

mvnetbiz commented Sep 21, 2018

jtojnar commented Sep 21, 2018

libratbag: init at v0.9.903 #46274

libratbag: init at v0.9.903 #46274

Conversation

mvnetbiz commented Sep 7, 2018 • edited

Motivation for this change

Things done

jtojnar commented Sep 8, 2018

jtojnar Sep 8, 2018

Choose a reason for hiding this comment

mvnetbiz Sep 10, 2018 • edited

Choose a reason for hiding this comment

jtojnar Sep 10, 2018

Choose a reason for hiding this comment

jtojnar Sep 8, 2018

Choose a reason for hiding this comment

mvnetbiz commented Sep 13, 2018

jtojnar Sep 13, 2018 • edited

Choose a reason for hiding this comment

mvnetbiz Sep 14, 2018

Choose a reason for hiding this comment

jtojnar Sep 14, 2018

Choose a reason for hiding this comment

jtojnar commented Sep 13, 2018

mvnetbiz commented Sep 14, 2018

jtojnar commented Sep 14, 2018

mvnetbiz commented Sep 18, 2018

jtojnar commented Sep 18, 2018

mvnetbiz commented Sep 18, 2018

mvnetbiz commented Sep 18, 2018

jtojnar commented Sep 18, 2018

mvnetbiz commented Sep 20, 2018

mvnetbiz commented Sep 20, 2018

jtojnar commented Sep 20, 2018 • edited

mvnetbiz commented Sep 21, 2018

jtojnar commented Sep 21, 2018

mvnetbiz commented Sep 7, 2018 •

edited

mvnetbiz Sep 10, 2018 •

edited

jtojnar Sep 13, 2018 •

edited

jtojnar commented Sep 20, 2018 •

edited