pinentry: remove multiple outputs

[fpletz]

Motivation for this change

Previously pinentry was a package with multiple outputs. This caused lots of rebuilds and always needs the dependencies of all flavors to build. Fixes #133156 #124753.

This PR refactors the different pinentry flavors into separate package builds and keeps the old interface for compatibility. As the attribute name pinentry would be misleading now it was renamed to pinentryFlavors. The old multiple outputs based interface is aliased for compatibility since this was not only used in the gnupg NixOS module but also the corresponding home-manager module.

Things done

• Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
• 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 packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
• Tested execution of all binary files (usually in ./result/bin/)
• 21.11 Release Notes (or backporting 21.05 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
• Fits CONTRIBUTING.md.

[r-rmcgibbo]

Result of nixpkgs-review pr 133542 at 010aa08a run on x86_64-linux 1

10 packages built successfully:

• kwalletcli
• nixos-install-tools
• passExtensions.pass-tomb
• pinentry-emacs (pinentry-curses)
• pinentry-gnome
• pinentry-gtk2
• pinentry-qt
• python38Packages.trezor_agent
• trezor_agent (python39Packages.trezor_agent)
• tomb

6 suggestions:

• warning: missing-patch-comment

  Consider adding a comment explaining the purpose of this patch on the line preceeding.
  Near pkgs/tools/security/pinentry/default.nix:48:9:

     |
  48 |         ./autoconf-ar.patch
     |         ^
  

• warning: build-tools-in-build-inputs

  sudo is a build tool so it likely goes to nativeBuildInputs, not buildInputs.

  Near pkgs/os-specific/linux/tomb/default.nix:16:3:

     |
  16 |   buildInputs = [ sudo zsh pinentry-curses ];
     |   ^
  

• warning: unclear-gpl

  gpl3 is a deprecated license, please check if project uses gpl3Plus or gpl3Only and change meta.license accordingly.

  Near pkgs/development/python-modules/trezor_agent/default.nix:33:5:

     |
  33 |     license = licenses.gpl3;
     |     ^
  

• warning: unclear-gpl

  gpl3 is a deprecated license, please check if project uses gpl3Plus or gpl3Only and change meta.license accordingly.

  Near pkgs/os-specific/linux/tomb/default.nix:40:5:

     |
  40 |     license     = licenses.gpl3;
     |     ^
  

• warning: missing-patch-comment

  Consider adding a comment explaining the purpose of this patch on the line preceeding.
  Near pkgs/tools/security/pinentry/default.nix:50:9:

     |
  50 |         (fetchpatch {
     |         ^
  

• warning: missing-phase-hooks

  installPhase should probably contain runHook preInstall and runHook postInstall.

  Near pkgs/os-specific/linux/tomb/default.nix:29:3:

     |
  29 |   installPhase = ''
     |   ^
  

---

Result of nixpkgs-review pr 133542 at 010aa08a run on aarch64-linux 1

9 packages built successfully:

• nixos-install-tools
• passExtensions.pass-tomb
• pinentry-emacs (pinentry-curses)
• pinentry-gnome
• pinentry-gtk2
• pinentry-qt
• python38Packages.trezor_agent
• trezor_agent (python39Packages.trezor_agent)
• tomb

1 suggestion:

• warning: unclear-gpl

  gpl3 is a deprecated license, please check if project uses gpl3Plus or gpl3Only and change meta.license accordingly.

  Near pkgs/development/python-modules/trezor_agent/default.nix:33:5:

     |
  33 |     license = licenses.gpl3;
     |     ^
  

[lheckemann]

Looks like a sensible approach to me. I think we can leave out the compatibility hack if we also have a corresponding home-manager PR.

[fpletz]

Thanks for the feedback. I've updated the PR and resolved the conflict with master (the qt variant does not build on aarch64-darwin).

I will open a home-manager PR later and remove the alias.

[Ma27]

Apart from the two comments below this seems reasonable to me.

[Ma27]

@fpletz may I ask what's the status here? :)

[SuperSandro2000]

@ofborg eval

[SuperSandro2000]

I've just noticed that we also need to add a pinentry to plasma6 and I just did that.

[SuperSandro2000]

Here goes nothing 🎉

[flokli]

This broke eval:

       error: undefined variable 'pinentryFlavor'

       at /nix/store/ngy0l9sly1qqg049584bwbiz9bb5x1mv-nixpkgs-src/nixos/modules/services/security/yubikey-agent.nix:40:49:

           39|     # yubikey-agent package
           40|     systemd.user.services.yubikey-agent = mkIf (pinentryFlavor != null) {
             |                                                 ^
           41|       path = [ config.programs.gnupg.agent.pinentryPackage ];
❯ 

[flokli]

Fix in #294771.