doc: update README with caveats about *-linux-musl support

[skip ci]
rake-compiler · Feb 7, 2024 · 3255e95 · 3255e95
1 parent ef73c80
commit 3255e95
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git 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
@@ -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