wayland-scanner: split from wayland

[alyssais]

Description of changes

We've used a wayland-scanner = wayland.bin alias for ages, to make packages clearer and allow them to be independently overridden. Going the whole way into splitting them into separate packages is useful because it means we can have different meta.platforms attributes for libwayland and wayland-scanner.

There is no duplication in outputs between the two packages — they don't install any files in common.

Draft because I'm going to need to test the downstream packages and make sure none were relying on pulling wayland-scanner from the wayland attribute.

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 23.05 Release Notes (or backporting 22.11 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
  • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
• Fits CONTRIBUTING.md.

[wegank]

The remaining occurrences of wayland.withLibraries are in

• pkgs/development/libraries/wayland/protocols.nix
• pkgs/tools/graphics/mesa-demos/default.nix (well...)

and also wayland.bin in

• pkgs/applications/networking/browsers/chromium/common.nix

[alyssais]

Things that still need to be checked:

• nix-review to catch packages that relied on wayland in buildInputs and strictDeps = false to get wayland-scanner
• test cross compilation of all packages that directly depend on wayland-scanner (they might need pkg-config in depsBuildBuild now)

[SuperSandro2000]

Thanks for cleaning this up

[trofi]

Bisect says 921bd99 wayland-scanner: split from wayland broke aquamarine build in staging as:

$ nix build --no-link -f. -L aquamarine
...
aquamarine> Running phase: buildPhase
aquamarine> build flags: -j16 SHELL=/nix/store/srq8ja7vpm3b95p2rhw149mx9pbfaqrv-bash-5.2p32/bin/bash
aquamarine> [  3%] Generating /build/source/protocols/xdg-shell.cpp, /build/source/protocols/xdg-shell.hpp
aquamarine> [  7%] Generating /build/source/protocols/linux-dmabuf-v1.cpp, /build/source/protocols/linux-dmabuf-v1.hpp
aquamarine> [ 11%] Generating /build/source/protocols/wayland.cpp, /build/source/protocols/wayland.hpp
aquamarine> Couldn't load proto
aquamarine> make[2]: *** [CMakeFiles/aquamarine.dir/build.make:74: /build/source/protocols/wayland.cpp] Error 1
aquamarine> make[2]: *** Waiting for unfinished jobs....
aquamarine> make[1]: *** [CMakeFiles/Makefile2:85: CMakeFiles/aquamarine.dir/all] Error 2
aquamarine> make: *** [Makefile:136: all] Error 2

[flokli]

Thanks for the report, I'll take a close look once I rebuilt things until there :-)

The package recipe might need some slight adjustments.

[flokli]

It was an issue with the upstream package picking from the wrong .pc file, which we exposed with the wayland-scanner split.

Fix in #335788.

[trofi]

Another casualty of 921bd99 wayland-scanner: split from wayland is wine64Packages.wayland on staging:

$ nix build --no-link -f. wine64Packages.wayland
...
wine64-wayland> checking for wayland-scanner... Package wayland-scanner was not found in the pkg-config search path.
wine64-wayland> Perhaps you should add the directory containing `wayland-scanner.pc'
wine64-wayland> to the PKG_CONFIG_PATH environment variable
wine64-wayland> No package 'wayland-scanner' found
wine64-wayland> no
...
wine64-wayland> configure: error: Wayland 64-bit development files not found or not new enough, the Wayland driver won't be supported.
wine64-wayland> This is an error since --with-wayland was requested.

[flokli]

Try adding wayland-scanner to buildInputs, so pkg-config can discover it?

[trofi]

Sounds good. Proposed the addition as:

• wine64Packages.wayland: add missing wayland-scanner build input #336001

[SomeoneSerge]

Try adding wayland-scanner to buildInputs, so pkg-config can discover it?

Idk much about how wine uses wayland-scanner, but why buildInputs and not native? Are you sure this isn't just working because strictDeps are off?

[trofi]

wine's generic nix code is a bit unusual in how it pulls in pkgs due to multi-abi support. Bringing wayland-scanner the same way it used to be exposed sounds simplest just to make it work again.

[flokli]

wine's generic nix code is a bit unusual in how it pulls in pkgs due to multi-abi support. Bringing wayland-scanner the same way it used to be exposed sounds simplest just to make it work again.

Fair enough, cleaning this up can be a separate PR, that PR is not making it more messy than it was before.

[trofi]

hyprland is another impacted package:

$ nix build --no-link -f. -L hyprland
...
hyprland> cd /build/source && hyprwayland-scanner --wayland-enums //nix/store/k3wz91y35macps9c811s68z207vxymc7-wayland-1.23.0/share/wayland/wayland.xml /build/source/protocols/
hyprland> Couldn't load proto

[flokli]

hyprland is another impacted package:

$ nix build --no-link -f. -L hyprland
...
hyprland> cd /build/source && hyprwayland-scanner --wayland-enums //nix/store/k3wz91y35macps9c811s68z207vxymc7-wayland-1.23.0/share/wayland/wayland.xml /build/source/protocols/
hyprland> Couldn't load proto

This is the same issue as it was in hyprwm/aquamarine#55. I sent a PR at hyprwm/Hyprland#7467.

nixpkgs PR at #336512