From 3255e956f3f22800b29745b0b918ac18b604f29c Mon Sep 17 00:00:00 2001 From: Mike Dalessio Date: Wed, 7 Feb 2024 16:21:18 -0500 Subject: [PATCH] doc: update README with caveats about `*-linux-musl` support [skip ci] --- History.md | 2 +- README.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/History.md b/History.md index 61be027..f870f4e 100644 --- a/History.md +++ b/History.md @@ -8,7 +8,7 @@ * Add Linux cross build targets `aarch64-linux-gnu`, `arm-linux-gnu`, `x86-linux-gnu`, and `x86_64-linux-gnu`. #111 (@flavorjones) * The cross build targets `aarch64-linux`, `arm-linux`, `x86-linux`, and `x86_64-linux` are now aliases for the `*-linux-gnu` targets. #111 (@flavorjones) -Please read the README for more details. +Please read the README for details and caveats. ## Improvements diff --git a/README.md b/README.md index e8960e4..88cca8d 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,10 @@ The `*-linux-gnu` and `*-linux-musl` platform name suffixes require Rubygems 3.3 - ruby: "2.5", rubygems: "3.3.26" - ruby: "2.4", rubygems: "3.3.26" +**It's strongly suggested that you use rake-compiler v1.2.7 or later to build `linux-musl` and/or `linux-gnu` native gems.** That version of rake-compiler sets `required_rubygems_version` appropriately in the native platform gems' gemspecs. + +Finally, there is a known bug in bundler before v2.5.6 that may make it difficult for users on musl systems to resolve their `linux-musl` dependencies correctly. You can read a description of this problem at https://github.com/rubygems/rubygems/issues/7432, but in summary **you should recommend your users have bundler v2.5.6 or later**. + ## Installation