From 91055a3a469066bf62b9710a17e572a8a22bf88b Mon Sep 17 00:00:00 2001 From: Jade Lovelace Date: Sat, 16 Mar 2024 16:30:31 -0700 Subject: [PATCH] nix-doc: disable plugin since it is broken by Lix API changes We don't intend to fix the API changes in nix-doc, because we should be able to kill nix-doc in like a week? --- nix-doc/package.nix | 64 +++++++++++++++++++++++++++++++++++++++++++++ overlay.nix | 5 +--- 2 files changed, 65 insertions(+), 4 deletions(-) create mode 100644 nix-doc/package.nix diff --git a/nix-doc/package.nix b/nix-doc/package.nix new file mode 100644 index 0000000..48ed473 --- /dev/null +++ b/nix-doc/package.nix @@ -0,0 +1,64 @@ +# Temporary replacement of the nix-doc package with +# https://github.com/NixOS/nixpkgs/pull/296523 so that we can have working Lix +# with nix-doc on 23.11 and 24.05-pre +# +# Can be removed when that commit is in 23.11 and 24.05-pre, or 24.05 is +# released with the commit. +{ lib +, stdenv +, rustPlatform +, fetchFromGitHub +, boost +, nix +, pkg-config +# Whether to build the nix-doc plugin for Nix +, withPlugin ? true +}: + +let + packageFlags = [ "-p" "nix-doc" ] ++ lib.optionals withPlugin [ "-p" "nix-doc-plugin" ]; +in +rustPlatform.buildRustPackage rec { + pname = "nix-doc"; + version = "0.6.5"; + + src = fetchFromGitHub { + rev = "v${version}"; + owner = "lf-"; + repo = "nix-doc"; + sha256 = "sha256-9cuNzq+CBA2jz0LkZb7lh/WISIlKklfovGBAbSo1Mgk="; + }; + + doCheck = true; + buildInputs = lib.optionals withPlugin [ boost nix ]; + + nativeBuildInputs = lib.optionals withPlugin [ pkg-config nix ]; + + cargoBuildFlags = packageFlags; + cargoTestFlags = packageFlags; + + # Packaging support for making the nix-doc plugin load cleanly as a no-op on + # the wrong Nix version (disabling bindnow permits loading libraries + # requiring unavailable symbols if they are unreached) + hardeningDisable = lib.optionals withPlugin [ "bindnow" ]; + # Due to a Rust bug, setting -Z relro-level to anything including "off" on + # macOS will cause link errors + env = lib.optionalAttrs (withPlugin && stdenv.isLinux) { + # nix-doc does not use nightly features, however, there is no other way to + # set relro-level + RUSTC_BOOTSTRAP = 1; + RUSTFLAGS = "-Z relro-level=partial"; + }; + + cargoSha256 = "sha256-CHagzXTG9AfrFd3WmHanQ+YddMgmVxSuB8vK98A1Mlw="; + + meta = with lib; { + description = "An interactive Nix documentation tool"; + longDescription = "An interactive Nix documentation tool providing a CLI for function search, a Nix plugin for docs in the REPL, and a ctags implementation for Nix script"; + homepage = "https://github.com/lf-/nix-doc"; + license = licenses.lgpl3Plus; + maintainers = [ maintainers.lf- ]; + platforms = platforms.unix; + mainProgram = "nix-doc"; + }; +} diff --git a/overlay.nix b/overlay.nix index 8e84a5f..3039d64 100644 --- a/overlay.nix +++ b/overlay.nix @@ -48,8 +48,5 @@ in nix = final.nixVersions.nix_2_18_upstream; }; - nix-doc = prev.nix-doc.overrideAttrs (old: { - # for the purposes of nix C++ API for nix-doc, lix is Nix 2.20 - NIX_CFLAGS_COMPILE = [ "-DNIX_2_20_0" ]; - }); + nix-doc = prev.callPackage ./nix-doc/package.nix { withPlugin = false; }; }