Commit 6daf525c authored by Matthew "strager" Glazar's avatar Matthew "strager" Glazar
Browse files

quick-lint-js: support cross compiling 

quick-lint-js' build system supports cross compiling, but it's not
automatic.

Prior to quick-lint-js version 2.13, cross compiling with Nix works
because some build-time tools are optional. These build-time tools need
a compiler from buildPackages.stdenv. Version 2.13 made these build-time
tools required.

Refactor the quick-lint-js package to use quick-lint-js' cross
compilation support. This fixes cross compilation with Nix.

Upstream documentation for cross compiling:
https://quick-lint-js.com/contribute/build-from-source/cross-compiling/

Testing:

    # Test Linux x86_64 cross compiling for Linux AArch64:
    x86$ uname -a
    Linux strapurp 6.2.0-35-generic #35~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Fri Oct  6 10:23:26 UTC 2 x86_64 x86_64 x86_64 GNU/Linux
    x86$ nix-shell -p pkgsCross.aarch64-multiplatform.quick-lint-js --run 'file $(which quick-lint-js)'
    /nix/store/3rdxhjxdmiwz1zg2mi477ysc9nb7jsqx-quick-lint-js-aarch64-unknown-linux-gnu-2.17.0/bin/quick-lint-js: ELF 64-bit LSB executable, ARM aarch64, version 1 (GNU/Linux), dynamically linked, interpreter /nix/store/5gdh4mp8rwliq4s33gwcpwzqvsb2xpzr-glibc-aarch64-unknown-linux-gnu-2.38-23/lib/ld-linux-aarch64.so.1, for GNU/Linux 3.10.0, not stripped

    # Test the binary on a Linux AArch64 machine:
    x86$ nix --extra-experimental-features nix-command copy --to ssh-ng://parallels@192.168.4.144 /nix/store/3rdxhjxdmiwz1zg2mi477ysc9nb7jsqx-quick-lint-js-aarch64-unknown-linux-gnu-2.17.0/
    arm$ /nix/store/3rdxhjxdmiwz1zg2mi477ysc9nb7jsqx-quick-lint-js-aarch64-unknown-linux-gnu-2.17.0/bin/quick-lint-js --version
    quick-lint-js version 2.17.0
parent 3704d0c7

pkgs/development/tools/quick-lint-js/build-tools-install.patch

0 → 100644
+32 −0
Original line number Diff line number Diff line 
From 3923f0df76d24b73d57f15eec61ab190ea048093 Mon Sep 17 00:00:00 2001

From: "Matthew \"strager\" Glazar" <strager.nds@gmail.com>

Date: Thu, 26 Oct 2023 18:08:30 -0400

Subject: [PATCH] fix(build): fix installing build tools for cross-compilation



'cmake --install . --component build-tools' copies no files [1]. This

was caused by commit 1f2e1a47 where the code calling install() became

dead code on accident. Call install() so that 'cmake --install' copies

the build artifacts as intended.



[1] https://github.com/quick-lint/quick-lint-js/issues/1099



Refs: 1f2e1a4701793cac24eaac44d7af81a8b820b1bc

---

 docs/CHANGELOG.md    | 7 +++++++

 tools/CMakeLists.txt | 1 -

 2 files changed, 7 insertions(+), 1 deletion(-)



 (docs/CHANGELOG.md changes omitted to reduce conflicts.)



diff --git a/tools/CMakeLists.txt b/tools/CMakeLists.txt

index 71ccbdf1b..b541afb52 100644

--- a/tools/CMakeLists.txt

+++ b/tools/CMakeLists.txt

@@ -68,7 +68,6 @@ if (QUICK_LINT_JS_ENABLE_BUILD_TOOLS)

     COMMENT "Building all quick-lint-js build-time tools"

     DEPENDS ${QUICK_LINT_JS_BUILD_TOOL_TARGETS}

   )

-elseif (QUICK_LINT_JS_ENABLE_BUILD_TOOLS)

   install(

     TARGETS ${QUICK_LINT_JS_BUILD_TOOL_TARGETS}

     COMPONENT build-tools

pkgs/development/tools/quick-lint-js/default.nix

+37 −6
Original line number Diff line number Diff line 
{ cmake, fetchFromGitHub, lib, ninja, stdenv, testers, quick-lint-js }:

{ buildPackages, cmake, fetchFromGitHub, lib, ninja, stdenv, testers, quick-lint-js }:





stdenv.mkDerivation rec {

  pname = "quick-lint-js";

let

  version = "2.17.0";



  src = fetchFromGitHub {
@@ -12,11 +10,41 @@ stdenv.mkDerivation rec { 
    sha256 = "sha256-5+Cyw1cLgBkTePNNFoNAF2oHnLQDHr4vHiaZHJrewug=";

  };



  quick-lint-js-build-tools = buildPackages.stdenv.mkDerivation {

    pname = "quick-lint-js-build-tools";

    inherit version src;



    patches = [ ./build-tools-install.patch ];



    nativeBuildInputs = [ cmake ninja ];

    doCheck = false;



    cmakeFlags = [

      "-DQUICK_LINT_JS_ENABLE_BUILD_TOOLS=ON"

      # Temporary workaround for https://github.com/NixOS/nixpkgs/pull/108496#issuecomment-1192083379

      "-DCMAKE_SKIP_BUILD_RPATH=ON"

    ];

    ninjaFlags = "quick-lint-js-build-tools";



    installPhase = ''

      runHook preInstall

      cmake --install . --component build-tools

      runHook postInstall

    '';

  };

in

stdenv.mkDerivation rec {

  pname = "quick-lint-js";

  inherit version src;



  nativeBuildInputs = [ cmake ninja ];

  doCheck = true;



  cmakeFlags = [

    "-DQUICK_LINT_JS_USE_BUILD_TOOLS=${quick-lint-js-build-tools}/bin"

    # Temporary workaround for https://github.com/NixOS/nixpkgs/pull/108496#issuecomment-1192083379

  cmakeFlags = [ "-DCMAKE_SKIP_BUILD_RPATH=ON" ];

    "-DCMAKE_SKIP_BUILD_RPATH=ON"

  ];



  passthru.tests = {

    version = testers.testVersion { package = quick-lint-js; };
@@ -29,4 +57,7 @@ stdenv.mkDerivation rec { 
    maintainers = with maintainers; [ ratsclub ];

    platforms = platforms.all;

  };



  # Expose quick-lint-js-build-tools to nix repl as quick-lint-js.build-tools.

  passthru.build-tools = quick-lint-js-build-tools;

}