diff options
author | Samuel Giddins <segiddins@segiddins.me> | 2016-12-26 15:33:18 -0600 |
---|---|---|
committer | Samuel Giddins <segiddins@segiddins.me> | 2016-12-26 15:33:18 -0600 |
commit | 6f50e4346383969655027f3a57f5e46c387fa2c8 (patch) | |
tree | 89d771c2d43580e4cc4a3d3018907f7a5097c795 | |
parent | 184f00487aa68504706ae3a2b76aa12bbf56f794 (diff) | |
download | bundler-6f50e4346383969655027f3a57f5e46c387fa2c8.tar.gz |
[Docs] Address feedback regarding platforms
-rw-r--r-- | man/bundle-config.ronn | 12 | ||||
-rw-r--r-- | man/bundle-lock.ronn | 2 |
2 files changed, 11 insertions, 3 deletions
diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn index 3562fb5315..fd15a24288 100644 --- a/man/bundle-config.ronn +++ b/man/bundle-config.ronn @@ -156,13 +156,19 @@ learn more about their operation in [bundle install(1)][bundle-install]. * `timeout` (`BUNDLE_TIMEOUT`): The seconds allowed before timing out for network requests. Defaults to `10`. * `force_ruby_platform` (`BUNDLE_FORCE_RUBY_PLATFORM`): - Force bundler to install the `ruby` platform version of gems, instead of - platform-specific gems. + Ignore the current machine's platform and install only `ruby` platform gems. + As a result, gems with native extensions will be compiled from source. * `specific_platform` (`BUNDLE_SPECIFIC_PLATFORM`): Allow bundler to resolve for the specific running platform and store it in the lockfile, instead of only using a generic platform. + A specific platform is the exact platform triple reported by + `Gem::Platform.local`, such as `x86_64-darwin-16` or `universal-java-1.8`. + On the other hand, generic platforms are those such as `ruby`, `mswin`, or + `java`. In this example, `x86_64-darwin-16` would map to `ruby` and + `universal-java-1.8` to `java`. * `disable_checksum_validation` (`BUNDLE_DISABLE_CHECKSUM_VALIDATION`): - Ignore the checksums of downloaded gems returned by rubygems sources. + Allow installing gems even if they do not match the checksum provided by + RubyGems. In general, you should set these settings per-application by using the applicable flag to the [bundle install(1)][bundle-install] or [bundle package(1)][bundle-package] command. diff --git a/man/bundle-lock.ronn b/man/bundle-lock.ronn index 74a03616dc..31ecd3c877 100644 --- a/man/bundle-lock.ronn +++ b/man/bundle-lock.ronn @@ -87,6 +87,8 @@ the lockfile, force bundler to re-resolve and consider the new platform when picking gems, all without needing to have a machine that matches PLATFORM handy to install those platform-specific gems on. +For a full explanation of gem platforms, see `gem help platform`. + ## PATCH LEVEL OPTIONS See [bundle update(1)][bundle-update] for details. |