Document upcoming changes to remembered options

rubygems · Jul 12, 2019 · c16bb52 · c16bb52
1 parent 509f4a7
commit c16bb52
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn
@@ -78,7 +78,8 @@ prevents Bundler from installing certain groups specified in the Gemfile(5). Bun
 persists this value in `app/.bundle/config` so that calls to `Bundler.setup`
 do not try to find gems from the `Gemfile` that you didn't install. Additionally,
 subsequent calls to [bundle install(1)](bundle-install.1.html) remember this setting
-and skip those groups.
+and skip those groups. (Upcoming changes in Bundler 3.x: `bundle install` will not
+remember any given flags. To persist options, you will have to use `bundle config`.)
 
 The canonical form of this configuration is `"without"`. To convert the canonical
 form to the environment variable form, capitalize it, and prepend `BUNDLE_`. The

diff --git a/man/bundle-install.ronn b/man/bundle-install.ronn
@@ -298,6 +298,12 @@ In addition, a call to `Bundler.setup` will not attempt to make the
 gems in those groups available on the Ruby load path, as they were
 not installed.
 
+Upcoming changes in Bundler 3.x: `bundle install` will not remember
+any given flags. To persist options, you will have to use
+`bundle config` (e.g., `bundle config path foo`).
+See the LIST OF AVAILABLE KEYS section in
+[bundle config(1)](bundle-config.1.html).
+
 The settings that are remembered are:
 
 * `--binstubs`: