Merge pull request #3915 from rubygems/note_cli_deprecations_in_docs

Note CLI flag deprecations in documentation

bundler/man/bundle-install.1

@@ -19,7 +19,7 @@ If a \fBGemfile\.lock\fR does exist, and you have not updated your Gemfile(5), B
 If a \fBGemfile\.lock\fR does exist, and you have updated your Gemfile(5), Bundler will use the dependencies in the \fBGemfile\.lock\fR for all gems that you did not update, but will re\-resolve the dependencies of gems that you did update\. You can find more information about this update process below under \fICONSERVATIVE UPDATING\fR\.
 .
 .SH "OPTIONS"
-To apply any of \fB\-\-binstubs\fR, \fB\-\-deployment\fR, \fB\-\-path\fR, or \fB\-\-without\fR every time \fBbundle install\fR is run, use \fBbundle config\fR (see bundle\-config(1))\.
+The \fB\-\-clean\fR, \fB\-\-deployment\fR, \fB\-\-frozen\fR, \fB\-\-no\-prune\fR, \fB\-\-path\fR, \fB\-\-shebang\fR, \fB\-\-system\fR, \fB\-\-without\fR and \fB\-\-with\fR options are deprecated because they only make sense if they are applied to every subsequent \fBbundle install\fR run automatically and that requires \fBbundler\fR to silently remember them\. Since \fBbundler\fR will no longer remember CLI flags in future versions, \fBbundle config\fR (see bundle\-config(1)) should be used to apply them permanently\.
 .
 .TP
 \fB\-\-binstubs[=<directory>]\fR
@@ -32,10 +32,16 @@ Creates a directory (defaults to \fB~/bin\fR) and places any executables from th
 \fB\-\-clean\fR
 On finishing the installation Bundler is going to remove any gems not present in the current Gemfile(5)\. Don\'t worry, gems currently in use will not be removed\.
 .
+.IP
+This option is deprecated in favor of the \fBclean\fR setting\.
+.
 .TP
 \fB\-\-deployment\fR
 In \fIdeployment mode\fR, Bundler will \'roll\-out\' the bundle for production or CI use\. Please check carefully if you want to have this option enabled in your development environment\.
 .
+.IP
+This option is deprecated in favor of the \fBdeployment\fR setting\.
+.
 .TP
 \fB\-\-redownload\fR
 Force download every gem, even if the required versions are already available locally\.
@@ -44,6 +50,9 @@ Force download every gem, even if the required versions are already available lo
 \fB\-\-frozen\fR
 Do not allow the Gemfile\.lock to be updated after this install\. Exits non\-zero if there are going to be changes to the Gemfile\.lock\.
 .
+.IP
+This option is deprecated in favor of the \fBfrozen\fR setting\.
+.
 .TP
 \fB\-\-full\-index\fR
 Bundler will not call Rubygems\' API endpoint (default) but download and cache a (currently big) index file of all gems\. Performance can be improved for large bundles that seldom change by enabling this option\.
@@ -68,10 +77,16 @@ Do not update the cache in \fBvendor/cache\fR with the newly bundled gems\. This
 \fB\-\-no\-prune\fR
 Don\'t remove stale gems from the cache when the installation finishes\.
 .
+.IP
+This option is deprecated in favor of the \fBno_prune\fR setting\.
+.
 .TP
 \fB\-\-path=<path>\fR
 The location to install the specified gems to\. This defaults to Rubygems\' setting\. Bundler shares this location with Rubygems, \fBgem install \.\.\.\fR will have gem installed there, too\. Therefore, gems installed without a \fB\-\-path \.\.\.\fR setting will show up by calling \fBgem list\fR\. Accordingly, gems installed to other locations will not get listed\.
 .
+.IP
+This option is deprecated in favor of the \fBpath\fR setting\.
+.
 .TP
 \fB\-\-quiet\fR
 Do not print progress information to the standard output\. Instead, Bundler will exit using a status code (\fB$?\fR)\.
@@ -84,6 +99,9 @@ Retry failed network or git requests for \fInumber\fR times\.
 \fB\-\-shebang=<ruby\-executable>\fR
 Uses the specified ruby executable (usually \fBruby\fR) to execute the scripts created with \fB\-\-binstubs\fR\. In addition, if you use \fB\-\-binstubs\fR together with \fB\-\-shebang jruby\fR these executables will be changed to execute \fBjruby\fR instead\.
 .
+.IP
+This option is deprecated in favor of the \fBshebang\fR setting\.
+.
 .TP
 \fB\-\-standalone[=<list>]\fR
 Makes a bundle that can work without depending on Rubygems or Bundler at runtime\. A space separated list of groups to install has to be specified\. Bundler creates a directory named \fBbundle\fR and installs the bundle there\. It also generates a \fBbundle/bundler/setup\.rb\fR file to replace Bundler\'s own setup in the manner required\. Using this option implicitly sets \fBpath\fR, which is a [remembered option][REMEMBERED OPTIONS]\.
@@ -92,6 +110,9 @@ Makes a bundle that can work without depending on Rubygems or Bundler at runtime
 \fB\-\-system\fR
 Installs the gems specified in the bundle to the system\'s Rubygems location\. This overrides any previous configuration of \fB\-\-path\fR\.
 .
+.IP
+This option is deprecated in favor of the \fBsystem\fR setting\.
+.
 .TP
 \fB\-\-trust\-policy=[<policy>]\fR
 Apply the Rubygems security policy \fIpolicy\fR, where policy is one of \fBHighSecurity\fR, \fBMediumSecurity\fR, \fBLowSecurity\fR, \fBAlmostNoSecurity\fR, or \fBNoSecurity\fR\. For more details, please see the Rubygems signing documentation linked below in \fISEE ALSO\fR\.
@@ -100,10 +121,16 @@ Apply the Rubygems security policy \fIpolicy\fR, where policy is one of \fBHighS
 \fB\-\-with=<list>\fR
 A space\-separated list of groups referencing gems to install\. If an optional group is given it is installed\. If a group is given that is in the remembered list of groups given to \-\-without, it is removed from that list\.
 .
+.IP
+This option is deprecated in favor of the \fBwith\fR setting\.
+.
 .TP
 \fB\-\-without=<list>\fR
 A space\-separated list of groups referencing gems to skip during installation\. If a group is given that is in the remembered list of groups given to \-\-with, it is removed from that list\.
 .
+.IP
+This option is deprecated in favor of the \fBwithout\fR setting\.
+.
 .SH "DEPLOYMENT MODE"
 Bundler\'s defaults are optimized for development\. To switch to defaults optimized for deployment and for CI, use the \fB\-\-deployment\fR flag\. Do not activate deployment mode on development machines, as it will cause an error when the Gemfile(5) is modified\.
 .