diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/bundle-config.1.html | 233 | ||||
| -rw-r--r-- | man/bundle-exec.1.html | 231 | ||||
| -rw-r--r-- | man/bundle-install.1.html | 428 | ||||
| -rw-r--r-- | man/bundle-package.1.html | 141 | ||||
| -rw-r--r-- | man/bundle-platform.1.html | 126 | ||||
| -rw-r--r-- | man/bundle-update.1.html | 262 | ||||
| -rw-r--r-- | man/bundle.1.html | 152 | ||||
| -rw-r--r-- | man/gemfile.5.html | 446 |
8 files changed, 0 insertions, 2019 deletions
diff --git a/man/bundle-config.1.html b/man/bundle-config.1.html deleted file mode 100644 index 281b88b52b..0000000000 --- a/man/bundle-config.1.html +++ /dev/null @@ -1,233 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta http-equiv='content-type' value='text/html;charset=utf8'> - <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'> - <title>bundle-config(1) - Set bundler configuration options</title> - <style type='text/css' media='all'> - /* style: man */ - body#manpage {margin:0} - .mp {max-width:100ex;padding:0 9ex 1ex 4ex} - .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0} - .mp h2 {margin:10px 0 0 0} - .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex} - .mp h3 {margin:0 0 0 4ex} - .mp dt {margin:0;clear:left} - .mp dt.flush {float:left;width:8ex} - .mp dd {margin:0 0 0 9ex} - .mp h1,.mp h2,.mp h3,.mp h4 {clear:left} - .mp pre {margin-bottom:20px} - .mp pre+h2,.mp pre+h3 {margin-top:22px} - .mp h2+pre,.mp h3+pre {margin-top:5px} - .mp img {display:block;margin:auto} - .mp h1.man-title {display:none} - .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143} - .mp h2 {font-size:16px;line-height:1.25} - .mp h1 {font-size:20px;line-height:2} - .mp {text-align:justify;background:#fff} - .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211} - .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201} - .mp u {text-decoration:underline} - .mp code,.mp strong,.mp b {font-weight:bold;color:#131211} - .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none} - .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff} - .mp b.man-ref {font-weight:normal;color:#434241} - .mp pre {padding:0 4ex} - .mp pre code {font-weight:normal;color:#434241} - .mp h2+pre,h3+pre {padding-left:0} - ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px} - ol.man-decor {width:100%} - ol.man-decor li.tl {text-align:left} - ol.man-decor li.tc {text-align:center;letter-spacing:4px} - ol.man-decor li.tr {text-align:right;float:right} - </style> -</head> -<!-- - The following styles are deprecated and will be removed at some point: - div#man, div#man ol.man, div#man ol.head, div#man ol.man. - - The .man-page, .man-decor, .man-head, .man-foot, .man-title, and - .man-navigation should be used instead. ---> -<body id='manpage'> - <div class='mp' id='man'> - - <div class='man-navigation' style='display:none'> - <a href="#NAME">NAME</a> - <a href="#SYNOPSIS">SYNOPSIS</a> - <a href="#DESCRIPTION">DESCRIPTION</a> - <a href="#BUILD-OPTIONS">BUILD OPTIONS</a> - <a href="#CONFIGURATION-KEYS">CONFIGURATION KEYS</a> - <a href="#LIST-OF-AVAILABLE-KEYS">LIST OF AVAILABLE KEYS</a> - <a href="#LOCAL-GIT-REPOS">LOCAL GIT REPOS</a> - <a href="#MIRRORS-OF-GEM-REPOSITORIES">MIRRORS OF GEM REPOSITORIES</a> - </div> - - <ol class='man-decor man-head man head'> - <li class='tl'>bundle-config(1)</li> - <li class='tc'></li> - <li class='tr'>bundle-config(1)</li> - </ol> - - <h2 id="NAME">NAME</h2> -<p class="man-name"> - <code>bundle-config</code> - <span class="man-whatis">Set bundler configuration options</span> -</p> - -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p><code>bundle config</code> [<var>name</var> [<var>value</var>]]</p> - -<h2 id="DESCRIPTION">DESCRIPTION</h2> - -<p>This command allows you to interact with bundler's configuration system. -Bundler retrieves its configuration from the local application (<code>app/.bundle/config</code>), -environment variables, and the user's home directory (<code>~/.bundle/config</code>), -in that order of priority.</p> - -<p>Executing <code>bundle config</code> with no parameters will print a list of all -bundler configuration for the current bundle, and where that configuration -was set.</p> - -<p>Executing <code>bundle config <name></code> will print the value of that configuration -setting, and where it was set.</p> - -<p>Executing <code>bundle config <name> <value></code> will set that configuration to the -value specified for all bundles executed as the current user. The configuration -will be stored in <code>~/.bundle/config</code>. If <var>name</var> already is set, <var>name</var> will be -overridden and user will be warned.</p> - -<p>Executing <code>bundle config --global <name> <value></code> works the same as above.</p> - -<p>Executing <code>bundle config --local <name> <value></code> will set that configuration to -the local application. The configuration will be stored in <code>app/.bundle/config</code>.</p> - -<p>Executing <code>bundle config --delete <name></code> will delete the configuration in both -local and global sources. Not compatible with --global or --local flag.</p> - -<p>Executing bundle with the <code>BUNDLE_IGNORE_CONFIG</code> environment variable set will -cause it to ignore all configuration.</p> - -<h2 id="BUILD-OPTIONS">BUILD OPTIONS</h2> - -<p>You can use <code>bundle config</code> to give bundler the flags to pass to the gem -installer every time bundler tries to install a particular gem.</p> - -<p>A very common example, the <code>mysql</code> gem, requires Snow Leopard users to -pass configuration flags to <code>gem install</code> to specify where to find the -<code>mysql_config</code> executable.</p> - -<pre><code>gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config -</code></pre> - -<p>Since the specific location of that executable can change from machine -to machine, you can specify these flags on a per-machine basis.</p> - -<pre><code>bundle config build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config -</code></pre> - -<p>After running this command, every time bundler needs to install the -<code>mysql</code> gem, it will pass along the flags you specified.</p> - -<h2 id="CONFIGURATION-KEYS">CONFIGURATION KEYS</h2> - -<p>Configuration keys in bundler have two forms: the canonical form and the -environment variable form.</p> - -<p>For instance, passing the <code>--without</code> flag to <a href="bundle-install.1.html">bundle install(1)</a> -prevents Bundler from installing certain groups specified in the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>. Bundler -persists this value in <code>app/.bundle/config</code> so that calls to <code>Bundler.setup</code> -do not try to find gems from the <code>Gemfile</code> that you didn't install. Additionally, -subsequent calls to <a href="bundle-install.1.html">bundle install(1)</a> remember this setting and skip those -groups.</p> - -<p>The canonical form of this configuration is <code>"without"</code>. To convert the canonical -form to the environment variable form, capitalize it, and prepend <code>BUNDLE_</code>. The -environment variable form of <code>"without"</code> is <code>BUNDLE_WITHOUT</code>.</p> - -<h2 id="LIST-OF-AVAILABLE-KEYS">LIST OF AVAILABLE KEYS</h2> - -<p>The following is a list of all configuration keys and their purpose. You can -learn more about their operation in <a href="bundle-install.1.html">bundle install(1)</a>.</p> - -<dl> -<dt><code>path</code> (<code>BUNDLE_PATH</code>)</dt><dd>The location on disk to install gems. Defaults to <code>$GEM_HOME</code> in development -and <code>vendor/bundler</code> when <code>--deployment</code> is used</dd> -<dt><code>frozen</code> (<code>BUNDLE_FROZEN</code>)</dt><dd>Disallow changes to the <code>Gemfile</code>. Defaults to <code>true</code> when <code>--deployment</code> -is used.</dd> -<dt><code>without</code> (<code>BUNDLE_WITHOUT</code>)</dt><dd>A <code>:</code>-separated list of groups whose gems bundler should not install</dd> -<dt><code>bin</code> (<code>BUNDLE_BIN</code>)</dt><dd>Install executables from gems in the bundle to the specified directory. -Defaults to <code>false</code>.</dd> -<dt><code>gemfile</code> (<code>BUNDLE_GEMFILE</code>)</dt><dd>The name of the file that bundler should use as the <code>Gemfile</code>. This location -of this file also sets the root of the project, which is used to resolve -relative paths in the <code>Gemfile</code>, among other things. By default, bundler -will search up from the current working directory until it finds a -<code>Gemfile</code>.</dd> -<dt><code>ssl_ca_cert</code> (<code>BUNDLE_SSL_CA_CERT</code>)</dt><dd>Path to a designated CA certificate file or folder containing multiple -certificates for trusted CAs in PEM format.</dd> -<dt><code>ssl_client_cert</code> (<code>BUNDLE_SSL_CLIENT_CERT</code>)</dt><dd>Path to a designated file containing a X.509 client certificate -and key in PEM format.</dd> -</dl> - - -<p>In general, you should set these settings per-application by using the applicable -flag to the <a href="bundle-install.1.html">bundle install(1)</a> command.</p> - -<p>You can set them globally either via environment variables or <code>bundle config</code>, -whichever is preferable for your setup. If you use both, environment variables -will take preference over global settings.</p> - -<h2 id="LOCAL-GIT-REPOS">LOCAL GIT REPOS</h2> - -<p>Bundler also allows you to work against a git repository locally -instead of using the remote version. This can be achieved by setting -up a local override:</p> - -<pre><code>bundle config local.GEM_NAME /path/to/local/git/repository -</code></pre> - -<p>For example, in order to use a local Rack repository, a developer could call:</p> - -<pre><code>bundle config local.rack ~/Work/git/rack -</code></pre> - -<p>Now instead of checking out the remote git repository, the local -override will be used. Similar to a path source, every time the local -git repository change, changes will be automatically picked up by -Bundler. This means a commit in the local git repo will update the -revision in the <code>Gemfile.lock</code> to the local git repo revision. This -requires the same attention as git submodules. Before pushing to -the remote, you need to ensure the local override was pushed, otherwise -you may point to a commit that only exists in your local machine.</p> - -<p>Bundler does many checks to ensure a developer won't work with -invalid references. Particularly, we force a developer to specify -a branch in the <code>Gemfile</code> in order to use this feature. If the branch -specified in the <code>Gemfile</code> and the current branch in the local git -repository do not match, Bundler will abort. This ensures that -a developer is always working against the correct branches, and prevents -accidental locking to a different branch.</p> - -<p>Finally, Bundler also ensures that the current revision in the -<code>Gemfile.lock</code> exists in the local git repository. By doing this, Bundler -forces you to fetch the latest changes in the remotes.</p> - -<h2 id="MIRRORS-OF-GEM-REPOSITORIES">MIRRORS OF GEM REPOSITORIES</h2> - -<p>Bundler supports overriding gem sources with mirrors. This allows you to -configure rubygems.org as the gem source in your Gemfile while still using your -mirror to fetch gems.</p> - -<pre><code>bundle config mirror.http://rubygems.org http://rubygems-mirror.org -</code></pre> - - - <ol class='man-decor man-foot man foot'> - <li class='tl'></li> - <li class='tc'>June 2014</li> - <li class='tr'>bundle-config(1)</li> - </ol> - - </div> -</body> -</html> diff --git a/man/bundle-exec.1.html b/man/bundle-exec.1.html deleted file mode 100644 index 8beae5b835..0000000000 --- a/man/bundle-exec.1.html +++ /dev/null @@ -1,231 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta http-equiv='content-type' value='text/html;charset=utf8'> - <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'> - <title>bundle-exec(1) - Execute a command in the context of the bundle</title> - <style type='text/css' media='all'> - /* style: man */ - body#manpage {margin:0} - .mp {max-width:100ex;padding:0 9ex 1ex 4ex} - .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0} - .mp h2 {margin:10px 0 0 0} - .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex} - .mp h3 {margin:0 0 0 4ex} - .mp dt {margin:0;clear:left} - .mp dt.flush {float:left;width:8ex} - .mp dd {margin:0 0 0 9ex} - .mp h1,.mp h2,.mp h3,.mp h4 {clear:left} - .mp pre {margin-bottom:20px} - .mp pre+h2,.mp pre+h3 {margin-top:22px} - .mp h2+pre,.mp h3+pre {margin-top:5px} - .mp img {display:block;margin:auto} - .mp h1.man-title {display:none} - .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143} - .mp h2 {font-size:16px;line-height:1.25} - .mp h1 {font-size:20px;line-height:2} - .mp {text-align:justify;background:#fff} - .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211} - .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201} - .mp u {text-decoration:underline} - .mp code,.mp strong,.mp b {font-weight:bold;color:#131211} - .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none} - .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff} - .mp b.man-ref {font-weight:normal;color:#434241} - .mp pre {padding:0 4ex} - .mp pre code {font-weight:normal;color:#434241} - .mp h2+pre,h3+pre {padding-left:0} - ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px} - ol.man-decor {width:100%} - ol.man-decor li.tl {text-align:left} - ol.man-decor li.tc {text-align:center;letter-spacing:4px} - ol.man-decor li.tr {text-align:right;float:right} - </style> -</head> -<!-- - The following styles are deprecated and will be removed at some point: - div#man, div#man ol.man, div#man ol.head, div#man ol.man. - - The .man-page, .man-decor, .man-head, .man-foot, .man-title, and - .man-navigation should be used instead. ---> -<body id='manpage'> - <div class='mp' id='man'> - - <div class='man-navigation' style='display:none'> - <a href="#NAME">NAME</a> - <a href="#SYNOPSIS">SYNOPSIS</a> - <a href="#DESCRIPTION">DESCRIPTION</a> - <a href="#OPTIONS">OPTIONS</a> - <a href="#BUNDLE-INSTALL-BINSTUBS">BUNDLE INSTALL --BINSTUBS</a> - <a href="#ENVIRONMENT-MODIFICATIONS">ENVIRONMENT MODIFICATIONS</a> - <a href="#RUBYGEMS-PLUGINS">RUBYGEMS PLUGINS</a> - </div> - - <ol class='man-decor man-head man head'> - <li class='tl'>bundle-exec(1)</li> - <li class='tc'></li> - <li class='tr'>bundle-exec(1)</li> - </ol> - - <h2 id="NAME">NAME</h2> -<p class="man-name"> - <code>bundle-exec</code> - <span class="man-whatis">Execute a command in the context of the bundle</span> -</p> - -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p><code>bundle exec</code> [--keep-file-descriptors] <var>command</var></p> - -<h2 id="DESCRIPTION">DESCRIPTION</h2> - -<p>This command executes the command, making all gems specified in the -<code>Gemfile(5)</code> available to <code>require</code> in Ruby programs.</p> - -<p>Essentially, if you would normally have run something like -<code>rspec spec/my_spec.rb</code>, and you want to use the gems specified -in the <code>Gemfile(5)</code> and installed via <a href="bundle-install.1.html">bundle install(1)</a>, you -should run <code>bundle exec rspec spec/my_spec.rb</code>.</p> - -<p>Note that <code>bundle exec</code> does not require that an executable is -available on your shell's <code>$PATH</code>.</p> - -<h2 id="OPTIONS">OPTIONS</h2> - -<dl> -<dt><code>--keep-file-descriptors</code></dt><dd>Exec in Ruby 2.0 began discarding non-standard file descriptors. When this -flag is passed, exec will revert to the 1.9 behaviour of passing all file -descriptors to the new process.</dd> -</dl> - - -<h2 id="BUNDLE-INSTALL-BINSTUBS">BUNDLE INSTALL --BINSTUBS</h2> - -<p>If you use the <code>--binstubs</code> flag in <a href="bundle-install.1.html">bundle install(1)</a>, Bundler will -automatically create a directory (which defaults to <code>app_root/bin</code>) -containing all of the executables available from gems in the bundle.</p> - -<p>After using <code>--binstubs</code>, <code>bin/rspec spec/my_spec.rb</code> is identical -to <code>bundle exec rspec spec/my_spec.rb</code>.</p> - -<h2 id="ENVIRONMENT-MODIFICATIONS">ENVIRONMENT MODIFICATIONS</h2> - -<p><code>bundle exec</code> makes a number of changes to the shell environment, -then executes the command you specify in full.</p> - -<ul> -<li>make sure that it's still possible to shell out to <code>bundle</code> -from inside a command invoked by <code>bundle exec</code> (using -<code>$BUNDLE_BIN_PATH</code>)</li> -<li>put the directory containing executables (like <code>rails</code>, <code>rspec</code>, -<code>rackup</code>) for your bundle on <code>$PATH</code></li> -<li>make sure that if bundler is invoked in the subshell, it uses -the same <code>Gemfile</code> (by setting <code>BUNDLE_GEMFILE</code>)</li> -<li>add <code>-rbundler/setup</code> to <code>$RUBYOPT</code>, which makes sure that -Ruby programs invoked in the subshell can see the gems in -the bundle</li> -</ul> - - -<p>It also modifies Rubygems:</p> - -<ul> -<li>disallow loading additional gems not in the bundle</li> -<li>modify the <code>gem</code> method to be a no-op if a gem matching -the requirements is in the bundle, and to raise a -<code>Gem::LoadError</code> if it's not</li> -<li>Define <code>Gem.refresh</code> to be a no-op, since the source -index is always frozen when using bundler, and to -prevent gems from the system leaking into the environment</li> -<li>Override <code>Gem.bin_path</code> to use the gems in the bundle, -making system executables work</li> -<li>Add all gems in the bundle into Gem.loaded_specs</li> -</ul> - - -<h3 id="Shelling-out">Shelling out</h3> - -<p>Any Ruby code that opens a subshell (like <code>system</code>, backticks, or <code>%x{}</code>) will -automatically use the current Bundler environment. If you need to shell out to -a Ruby command that is not part of your current bundle, use the -<code>with_clean_env</code> method with a block. Any subshells created inside the block -will be given the environment present before Bundler was activated. For -example, Homebrew commands run Ruby, but don't work inside a bundle:</p> - -<pre><code>Bundler.with_clean_env do - `brew install wget` -end -</code></pre> - -<p>Using <code>with_clean_env</code> is also necessary if you are shelling out to a different -bundle. Any Bundler commands run in a subshell will inherit the current -Gemfile, so commands that need to run in the context of a different bundle also -need to use <code>with_clean_env</code>.</p> - -<pre><code>Bundler.with_clean_env do - Dir.chdir "/other/bundler/project" do - `bundle exec ./script` - end -end -</code></pre> - -<p>Bundler provides convenience helpers that wrap <code>system</code> and <code>exec</code>, and they -can be used like this:</p> - -<pre><code>Bundler.clean_system('brew install wget') -Bundler.clean_exec('brew install wget') -</code></pre> - -<h2 id="RUBYGEMS-PLUGINS">RUBYGEMS PLUGINS</h2> - -<p>At present, the Rubygems plugin system requires all files -named <code>rubygems_plugin.rb</code> on the load path of <em>any</em> installed -gem when any Ruby code requires <code>rubygems.rb</code>. This includes -executables installed into the system, like <code>rails</code>, <code>rackup</code>, -and <code>rspec</code>.</p> - -<p>Since Rubygems plugins can contain arbitrary Ruby code, they -commonly end up activating themselves or their dependencies.</p> - -<p>For instance, the <code>gemcutter 0.5</code> gem depended on <code>json_pure</code>. -If you had that version of gemcutter installed (even if -you <em>also</em> had a newer version without this problem), Rubygems -would activate <code>gemcutter 0.5</code> and <code>json_pure <latest></code>.</p> - -<p>If your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> also contained <code>json_pure</code> (or a gem -with a dependency on <code>json_pure</code>), the latest version on -your system might conflict with the version in your -<a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>, or the snapshot version in your <code>Gemfile.lock</code>.</p> - -<p>If this happens, bundler will say:</p> - -<pre><code>You have already activated json_pure 1.4.6 but your Gemfile -requires json_pure 1.4.3. Consider using bundle exec. -</code></pre> - -<p>In this situation, you almost certainly want to remove the -underlying gem with the problematic gem plugin. In general, -the authors of these plugins (in this case, the <code>gemcutter</code> -gem) have released newer versions that are more careful in -their plugins.</p> - -<p>You can find a list of all the gems containing gem plugins -by running</p> - -<pre><code>ruby -rubygems -e "puts Gem.find_files('rubygems_plugin.rb')" -</code></pre> - -<p>At the very least, you should remove all but the newest -version of each gem plugin, and also remove all gem plugins -that you aren't using (<code>gem uninstall gem_name</code>).</p> - - - <ol class='man-decor man-foot man foot'> - <li class='tl'></li> - <li class='tc'>June 2014</li> - <li class='tr'>bundle-exec(1)</li> - </ol> - - </div> -</body> -</html> diff --git a/man/bundle-install.1.html b/man/bundle-install.1.html deleted file mode 100644 index 9d489b0684..0000000000 --- a/man/bundle-install.1.html +++ /dev/null @@ -1,428 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta http-equiv='content-type' value='text/html;charset=utf8'> - <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'> - <title>bundle-install(1) - Install the dependencies specified in your Gemfile</title> - <style type='text/css' media='all'> - /* style: man */ - body#manpage {margin:0} - .mp {max-width:100ex;padding:0 9ex 1ex 4ex} - .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0} - .mp h2 {margin:10px 0 0 0} - .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex} - .mp h3 {margin:0 0 0 4ex} - .mp dt {margin:0;clear:left} - .mp dt.flush {float:left;width:8ex} - .mp dd {margin:0 0 0 9ex} - .mp h1,.mp h2,.mp h3,.mp h4 {clear:left} - .mp pre {margin-bottom:20px} - .mp pre+h2,.mp pre+h3 {margin-top:22px} - .mp h2+pre,.mp h3+pre {margin-top:5px} - .mp img {display:block;margin:auto} - .mp h1.man-title {display:none} - .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143} - .mp h2 {font-size:16px;line-height:1.25} - .mp h1 {font-size:20px;line-height:2} - .mp {text-align:justify;background:#fff} - .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211} - .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201} - .mp u {text-decoration:underline} - .mp code,.mp strong,.mp b {font-weight:bold;color:#131211} - .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none} - .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff} - .mp b.man-ref {font-weight:normal;color:#434241} - .mp pre {padding:0 4ex} - .mp pre code {font-weight:normal;color:#434241} - .mp h2+pre,h3+pre {padding-left:0} - ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px} - ol.man-decor {width:100%} - ol.man-decor li.tl {text-align:left} - ol.man-decor li.tc {text-align:center;letter-spacing:4px} - ol.man-decor li.tr {text-align:right;float:right} - </style> -</head> -<!-- - The following styles are deprecated and will be removed at some point: - div#man, div#man ol.man, div#man ol.head, div#man ol.man. - - The .man-page, .man-decor, .man-head, .man-foot, .man-title, and - .man-navigation should be used instead. ---> -<body id='manpage'> - <div class='mp' id='man'> - - <div class='man-navigation' style='display:none'> - <a href="#NAME">NAME</a> - <a href="#SYNOPSIS">SYNOPSIS</a> - <a href="#DESCRIPTION">DESCRIPTION</a> - <a href="#OPTIONS">OPTIONS</a> - <a href="#DEPLOYMENT-MODE">DEPLOYMENT MODE</a> - <a href="#SUDO-USAGE">SUDO USAGE</a> - <a href="#INSTALLING-GROUPS">INSTALLING GROUPS</a> - <a href="#REMEMBERED-OPTIONS">REMEMBERED OPTIONS</a> - <a href="#THE-GEMFILE-LOCK">THE GEMFILE.LOCK</a> - <a href="#CONSERVATIVE-UPDATING">CONSERVATIVE UPDATING</a> - <a href="#SEE-ALSO">SEE ALSO</a> - </div> - - <ol class='man-decor man-head man head'> - <li class='tl'>bundle-install(1)</li> - <li class='tc'></li> - <li class='tr'>bundle-install(1)</li> - </ol> - - <h2 id="NAME">NAME</h2> -<p class="man-name"> - <code>bundle-install</code> - <span class="man-whatis">Install the dependencies specified in your Gemfile</span> -</p> - -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p><code>bundle install</code> [--gemfile=GEMFILE] - [--path PATH] [--system] - [--without=GROUP1[ GROUP2...]] - [--local] [--deployment] - [--binstubs[=DIRECTORY]] - [--standalone[=GROUP1[ GROUP2...]]] - [--trust-policy=POLICY] - [--jobs=SIZE] - [--retry=TRIES] - [--no-cache] - [--quiet]</p> - -<h2 id="DESCRIPTION">DESCRIPTION</h2> - -<p>Install the gems specified in your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>. If this is the first -time you run bundle install (and a <code>Gemfile.lock</code> does not exist), -bundler will fetch all remote sources, resolve dependencies and -install all needed gems.</p> - -<p>If a <code>Gemfile.lock</code> does exist, and you have not updated your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>, -bundler will fetch all remote sources, but use the dependencies -specified in the <code>Gemfile.lock</code> instead of resolving dependencies.</p> - -<p>If a <code>Gemfile.lock</code> does exist, and you have updated your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>, -bundler will use the dependencies in the <code>Gemfile.lock</code> 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 <a href="#CONSERVATIVE-UPDATING" title="CONSERVATIVE UPDATING" data-bare-link="true">CONSERVATIVE UPDATING</a>.</p> - -<h2 id="OPTIONS">OPTIONS</h2> - -<dl> -<dt><code>--gemfile=<gemfile></code></dt><dd><p>The location of the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> that bundler should use. This defaults -to a gemfile in the current working directory. In general, bundler -will assume that the location of the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> is also the project -root, and will look for the <code>Gemfile.lock</code> and <code>vendor/cache</code> relative -to it.</p></dd> -<dt><code>--path=<path></code></dt><dd><p>The location to install the gems in the bundle to. This defaults to -Rubygems' gem home, which is also the default location where <code>gem -install</code> installs gems. This means that, by default, gems installed -without a <code>--path</code> setting will show up in <code>gem list</code>. This setting is -a <a href="#REMEMBERED-OPTIONS" title="REMEMBERED OPTIONS" data-bare-link="true">remembered option</a>.</p></dd> -<dt><code>--system</code></dt><dd><p>Installs the gems in the bundle to the system location. This -overrides any previous <a href="#REMEMBERED-OPTIONS" title="REMEMBERED OPTIONS" data-bare-link="true">remembered</a> use of -<code>--path</code>.</p></dd> -<dt><code>--without=<list></code></dt><dd><p>A space-separated list of groups to skip installing. This is a -<a href="#REMEMBERED-OPTIONS" title="REMEMBERED OPTIONS" data-bare-link="true">remembered option</a>.</p></dd> -<dt class="flush"><code>--local</code></dt><dd><p>Do not attempt to connect to <code>rubygems.org</code>, instead using just -the gems already present in Rubygems' cache or in <code>vendor/cache</code>. -Note that if a more appropriate platform-specific gem exists on -<code>rubygems.org</code>, it will not be found.</p></dd> -<dt><code>--deployment</code></dt><dd><p>Switches bundler's defaults into <a href="#DEPLOYMENT-MODE" title="DEPLOYMENT MODE" data-bare-link="true">deployment mode</a>. -Do not use this flag on development machines.</p></dd> -<dt><code>--binstubs[=<directory>]</code></dt><dd><p>Create a directory (defaults to <code>bin</code>) containing an executable -that runs in the context of the bundle. For instance, if the -<code>rails</code> gem comes with a <code>rails</code> executable, this flag will create -a <code>bin/rails</code> executable that ensures that all dependencies used -come from the bundled gems.</p></dd> -<dt><code>--shebang ruby-install-name</code></dt><dd><p>Uses the ruby executable (usually <code>ruby</code>) provided to execute the scripts created -with --binstubs. For instance, if you use --binstubs with <code>--shebang jruby</code>, -all executables will be created to use jruby instead.</p></dd> -<dt><code>--standalone[=<list>]</code></dt><dd><p>Make a bundle that can work without Ruby Gems or Bundler at runtime. -It takes a space separated list of groups to install. It creates a -<code>bundle</code> directory and installs the bundle there. It also generates -a <code>bundle/bundler/setup.rb</code> file to replace Bundler's own setup.</p></dd> -<dt><code>--trust-policy=[<policy>]</code></dt><dd><p>Apply the Rubygems security policy named <var>policy</var>, where policy is one of -HighSecurity, MediumSecurity, LowSecurity, or NoSecurity. For more detail, -see the Rubygems signing documentation, linked below in <a href="#SEE-ALSO" title="SEE ALSO" data-bare-link="true">SEE ALSO</a>.</p></dd> -<dt><code>--jobs=[<size>]</code></dt><dd><p>Install gems parallely by starting <var>size</var> number of parallel workers.</p></dd> -<dt><code>--retry[<tries]</code></dt><dd><p>Retries failed network or git requests <var>tries</var> times.</p></dd> -<dt><code>--no-cache</code></dt><dd><p>Do not update the cache in <code>vendor/cache</code> with the newly bundled gems. This -does not remove any existing cached gems, only stops the newly bundled gems -from being cached during the install.</p></dd> -<dt class="flush"><code>--quiet</code></dt><dd><p>Do not print progress information to stdout. Instead, communicate the -success of the install operation via exit status code.</p></dd> -</dl> - - -<h2 id="DEPLOYMENT-MODE">DEPLOYMENT MODE</h2> - -<p>Bundler's defaults are optimized for development. To switch to -defaults optimized for deployment, use the <code>--deployment</code> flag. -Do not activate deployment mode on development machines, as it -will cause in an error when the Gemfile is modified.</p> - -<ol> -<li><p>A <code>Gemfile.lock</code> is required.</p> - -<p>To ensure that the same versions of the gems you developed with -and tested with are also used in deployments, a <code>Gemfile.lock</code> -is required.</p> - -<p>This is mainly to ensure that you remember to check your -<code>Gemfile.lock</code> into version control.</p></li> -<li><p>The <code>Gemfile.lock</code> must be up to date</p> - -<p>In development, you can modify your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> and re-run -<code>bundle install</code> to <a href="#CONSERVATIVE-UPDATING" title="CONSERVATIVE UPDATING" data-bare-link="true">conservatively update</a> -your <code>Gemfile.lock</code> snapshot.</p> - -<p>In deployment, your <code>Gemfile.lock</code> should be up-to-date with -changes made in your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>.</p></li> -<li><p>Gems are installed to <code>vendor/bundle</code> not your default system location</p> - -<p>In development, it's convenient to share the gems used in your -application with other applications and other scripts run on -the system.</p> - -<p>In deployment, isolation is a more important default. In addition, -the user deploying the application may not have permission to install -gems to the system, or the web server may not have permission to -read them.</p> - -<p>As a result, <code>bundle install --deployment</code> installs gems to -the <code>vendor/bundle</code> directory in the application. This may be -overridden using the <code>--path</code> option.</p></li> -</ol> - - -<h2 id="SUDO-USAGE">SUDO USAGE</h2> - -<p>By default, bundler installs gems to the same location as <code>gem install</code>.</p> - -<p>In some cases, that location may not be writable by your Unix user. In -that case, bundler will stage everything in a temporary directory, -then ask you for your <code>sudo</code> password in order to copy the gems into -their system location.</p> - -<p>From your perspective, this is identical to installing them gems -directly into the system.</p> - -<p>You should never use <code>sudo bundle install</code>. This is because several -other steps in <code>bundle install</code> must be performed as the current user:</p> - -<ul> -<li>Updating your <code>Gemfile.lock</code></li> -<li>Updating your <code>vendor/cache</code>, if necessary</li> -<li>Checking out private git repositories using your user's SSH keys</li> -</ul> - - -<p>Of these three, the first two could theoretically be performed by -<code>chown</code>ing the resulting files to <code>$SUDO_USER</code>. The third, however, -can only be performed by actually invoking the <code>git</code> command as -the current user. Therefore, git gems are downloaded and installed -into <code>~/.bundle</code> rather than $GEM_HOME or $BUNDLE_PATH.</p> - -<p>As a result, you should run <code>bundle install</code> as the current user, -and bundler will ask for your password if it is needed to put the -gems into their final location.</p> - -<h2 id="INSTALLING-GROUPS">INSTALLING GROUPS</h2> - -<p>By default, <code>bundle install</code> will install all gems in all groups -in your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>, except those declared for a different platform.</p> - -<p>However, you can explicitly tell bundler to skip installing -certain groups with the <code>--without</code> option. This option takes -a space-separated list of groups.</p> - -<p>While the <code>--without</code> option will skip <em>installing</em> the gems in the -specified groups, it will still <em>download</em> those gems and use them to -resolve the dependencies of every gem in your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>.</p> - -<p>This is so that installing a different set of groups on another - machine (such as a production server) will not change the -gems and versions that you have already developed and tested against.</p> - -<p><code>Bundler offers a rock-solid guarantee that the third-party -code you are running in development and testing is also the -third-party code you are running in production. You can choose -to exclude some of that code in different environments, but you -will never be caught flat-footed by different versions of -third-party code being used in different environments.</code></p> - -<p>For a simple illustration, consider the following <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>:</p> - -<pre><code>source "https://rubygems.org" - -gem "sinatra" - -group :production do - gem "rack-perftools-profiler" -end -</code></pre> - -<p>In this case, <code>sinatra</code> depends on any version of Rack (<code>>= 1.0</code>, while -<code>rack-perftools-profiler</code> depends on 1.x (<code>~> 1.0</code>).</p> - -<p>When you run <code>bundle install --without production</code> in development, we -look at the dependencies of <code>rack-perftools-profiler</code> as well. That way, -you do not spend all your time developing against Rack 2.0, using new -APIs unavailable in Rack 1.x, only to have bundler switch to Rack 1.2 -when the <code>production</code> group <em>is</em> used.</p> - -<p>This should not cause any problems in practice, because we do not -attempt to <code>install</code> the gems in the excluded groups, and only evaluate -as part of the dependency resolution process.</p> - -<p>This also means that you cannot include different versions of the same -gem in different groups, because doing so would result in different -sets of dependencies used in development and production. Because of -the vagaries of the dependency resolution process, this usually -affects more than just the gems you list in your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>, and can -(surprisingly) radically change the gems you are using.</p> - -<h2 id="REMEMBERED-OPTIONS">REMEMBERED OPTIONS</h2> - -<p>Some options (marked above in the <a href="#OPTIONS" title="OPTIONS" data-bare-link="true">OPTIONS</a> section) are remembered -between calls to <code>bundle install</code>, and by the Bundler runtime.</p> - -<p>For instance, if you run <code>bundle install --without test</code>, a subsequent -call to <code>bundle install</code> that does not include a <code>--without</code> flag will -remember your previous choice.</p> - -<p>In addition, a call to <code>Bundler.setup</code> will not attempt to make the -gems in those groups available on the Ruby load path, as they were -not installed.</p> - -<p>The settings that are remembered are:</p> - -<dl> -<dt><code>--deployment</code></dt><dd><p>At runtime, this remembered setting will also result in Bundler -raising an exception if the <code>Gemfile.lock</code> is out of date.</p></dd> -<dt class="flush"><code>--path</code></dt><dd><p>Subsequent calls to <code>bundle install</code> will install gems to the -directory originally passed to <code>--path</code>. The Bundler runtime -will look for gems in that location. You can revert this -option by running <code>bundle install --system</code>.</p></dd> -<dt><code>--binstubs</code></dt><dd><p>Bundler will update the executables every subsequent call to -<code>bundle install</code>.</p></dd> -<dt><code>--without</code></dt><dd><p>As described above, Bundler will skip the gems specified by -<code>--without</code> in subsequent calls to <code>bundle install</code>. The -Bundler runtime will also not try to make the gems in the -skipped groups available.</p></dd> -</dl> - - -<h2 id="THE-GEMFILE-LOCK">THE GEMFILE.LOCK</h2> - -<p>When you run <code>bundle install</code>, Bundler will persist the full names -and versions of all gems that you used (including dependencies of -the gems specified in the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>) into a file called <code>Gemfile.lock</code>.</p> - -<p>Bundler uses this file in all subsequent calls to <code>bundle install</code>, -which guarantees that you always use the same exact code, even -as your application moves across machines.</p> - -<p>Because of the way dependency resolution works, even a -seemingly small change (for instance, an update to a point-release -of a dependency of a gem in your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>) can result in radically -different gems being needed to satisfy all dependencies.</p> - -<p>As a result, you <code>SHOULD</code> check your <code>Gemfile.lock</code> into version -control. If you do not, every machine that checks out your -repository (including your production server) will resolve all -dependencies again, which will result in different versions of -third-party code being used if <code>any</code> of the gems in the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> -or any of their dependencies have been updated.</p> - -<h2 id="CONSERVATIVE-UPDATING">CONSERVATIVE UPDATING</h2> - -<p>When you make a change to the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> and then run <code>bundle install</code>, -Bundler will update only the gems that you modified.</p> - -<p>In other words, if a gem that you <code>did not modify</code> worked before -you called <code>bundle install</code>, it will continue to use the exact -same versions of all dependencies as it used before the update.</p> - -<p>Let's take a look at an example. Here's your original <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>:</p> - -<pre><code>source "https://rubygems.org" - -gem "actionpack", "2.3.8" -gem "activemerchant" -</code></pre> - -<p>In this case, both <code>actionpack</code> and <code>activemerchant</code> depend on -<code>activesupport</code>. The <code>actionpack</code> gem depends on <code>activesupport 2.3.8</code> -and <code>rack ~> 1.1.0</code>, while the <code>activemerchant</code> gem depends on -<code>activesupport >= 2.3.2</code>, <code>braintree >= 2.0.0</code>, and <code>builder >= 2.0.0</code>.</p> - -<p>When the dependencies are first resolved, Bundler will select -<code>activesupport 2.3.8</code>, which satisfies the requirements of both -gems in your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>.</p> - -<p>Next, you modify your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> to:</p> - -<pre><code>source "https://rubygems.org" - -gem "actionpack", "3.0.0.rc" -gem "activemerchant" -</code></pre> - -<p>The <code>actionpack 3.0.0.rc</code> gem has a number of new dependencies, -and updates the <code>activesupport</code> dependency to <code>= 3.0.0.rc</code> and -the <code>rack</code> dependency to <code>~> 1.2.1</code>.</p> - -<p>When you run <code>bundle install</code>, Bundler notices that you changed -the <code>actionpack</code> gem, but not the <code>activemerchant</code> gem. It -evaluates the gems currently being used to satisfy its requirements:</p> - -<dl> -<dt><code>activesupport 2.3.8</code></dt><dd>also used to satisfy a dependency in <code>activemerchant</code>, -which is not being updated</dd> -<dt><code>rack ~> 1.1.0</code></dt><dd>not currently being used to satisfy another dependency</dd> -</dl> - - -<p>Because you did not explicitly ask to update <code>activemerchant</code>, -you would not expect it to suddenly stop working after updating -<code>actionpack</code>. However, satisfying the new <code>activesupport 3.0.0.rc</code> -dependency of actionpack requires updating one of its dependencies.</p> - -<p>Even though <code>activemerchant</code> declares a very loose dependency -that theoretically matches <code>activesupport 3.0.0.rc</code>, bundler treats -gems in your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> that have not changed as an atomic unit -together with their dependencies. In this case, the <code>activemerchant</code> -dependency is treated as <code>activemerchant 1.7.1 + activesupport 2.3.8</code>, -so <code>bundle install</code> will report that it cannot update <code>actionpack</code>.</p> - -<p>To explicitly update <code>actionpack</code>, including its dependencies -which other gems in the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> still depend on, run -<code>bundle update actionpack</code> (see <code>bundle update(1)</code>).</p> - -<p><code>Summary</code>: In general, after making a change to the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> , you -should first try to run <code>bundle install</code>, which will guarantee that no -other gems in the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> are impacted by the change. If that -does not work, run <a href="bundle-update.1.html">bundle update(1)</a>.</p> - -<h2 id="SEE-ALSO">SEE ALSO</h2> - -<ul> -<li>Gem install docs: http://docs.rubygems.org/read/chapter/2</li> -<li>Rubygems signing docs: http://docs.rubygems.org/read/chapter/21</li> -</ul> - - - - <ol class='man-decor man-foot man foot'> - <li class='tl'></li> - <li class='tc'>June 2014</li> - <li class='tr'>bundle-install(1)</li> - </ol> - - </div> -</body> -</html> diff --git a/man/bundle-package.1.html b/man/bundle-package.1.html deleted file mode 100644 index b3cbb22aa7..0000000000 --- a/man/bundle-package.1.html +++ /dev/null @@ -1,141 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta http-equiv='content-type' value='text/html;charset=utf8'> - <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'> - <title>bundle-package(1) - Package your needed <code>.gem</code> files into your application</title> - <style type='text/css' media='all'> - /* style: man */ - body#manpage {margin:0} - .mp {max-width:100ex;padding:0 9ex 1ex 4ex} - .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0} - .mp h2 {margin:10px 0 0 0} - .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex} - .mp h3 {margin:0 0 0 4ex} - .mp dt {margin:0;clear:left} - .mp dt.flush {float:left;width:8ex} - .mp dd {margin:0 0 0 9ex} - .mp h1,.mp h2,.mp h3,.mp h4 {clear:left} - .mp pre {margin-bottom:20px} - .mp pre+h2,.mp pre+h3 {margin-top:22px} - .mp h2+pre,.mp h3+pre {margin-top:5px} - .mp img {display:block;margin:auto} - .mp h1.man-title {display:none} - .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143} - .mp h2 {font-size:16px;line-height:1.25} - .mp h1 {font-size:20px;line-height:2} - .mp {text-align:justify;background:#fff} - .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211} - .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201} - .mp u {text-decoration:underline} - .mp code,.mp strong,.mp b {font-weight:bold;color:#131211} - .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none} - .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff} - .mp b.man-ref {font-weight:normal;color:#434241} - .mp pre {padding:0 4ex} - .mp pre code {font-weight:normal;color:#434241} - .mp h2+pre,h3+pre {padding-left:0} - ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px} - ol.man-decor {width:100%} - ol.man-decor li.tl {text-align:left} - ol.man-decor li.tc {text-align:center;letter-spacing:4px} - ol.man-decor li.tr {text-align:right;float:right} - </style> -</head> -<!-- - The following styles are deprecated and will be removed at some point: - div#man, div#man ol.man, div#man ol.head, div#man ol.man. - - The .man-page, .man-decor, .man-head, .man-foot, .man-title, and - .man-navigation should be used instead. ---> -<body id='manpage'> - <div class='mp' id='man'> - - <div class='man-navigation' style='display:none'> - <a href="#NAME">NAME</a> - <a href="#SYNOPSIS">SYNOPSIS</a> - <a href="#DESCRIPTION">DESCRIPTION</a> - <a href="#GIT-AND-PATH-GEMS">GIT AND PATH GEMS</a> - <a href="#REMOTE-FETCHING">REMOTE FETCHING</a> - </div> - - <ol class='man-decor man-head man head'> - <li class='tl'>bundle-package(1)</li> - <li class='tc'></li> - <li class='tr'>bundle-package(1)</li> - </ol> - - <h2 id="NAME">NAME</h2> -<p class="man-name"> - <code>bundle-package</code> - <span class="man-whatis">Package your needed <code>.gem</code> files into your application</span> -</p> - -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p><code>bundle package</code></p> - -<h2 id="DESCRIPTION">DESCRIPTION</h2> - -<p>Copy all of the <code>.gem</code> files needed to run the application into the -<code>vendor/cache</code> directory. In the future, when running <a href="bundle-install.1.html">bundle install(1)</a>, -use the gems in the cache in preference to the ones on <code>rubygems.org</code>.</p> - -<h2 id="GIT-AND-PATH-GEMS">GIT AND PATH GEMS</h2> - -<p>Since Bundler 1.2, the <code>bundle package</code> command can also package <code>:git</code> and -<code>:path</code> dependencies besides .gem files. This needs to be explicitly enabled -via the <code>--all</code> option. Once used, the <code>--all</code> option will be remembered.</p> - -<h2 id="REMOTE-FETCHING">REMOTE FETCHING</h2> - -<p>By default, if you simply run <a href="bundle-install.1.html">bundle install(1)</a> after running -<a href="bundle-package.1.html">bundle package(1)</a>, bundler will still connect to <code>rubygems.org</code> -to check whether a platform-specific gem exists for any of the gems -in <code>vendor/cache</code>.</p> - -<p>For instance, consider this <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>:</p> - -<pre><code>source "https://rubygems.org" - -gem "nokogiri" -</code></pre> - -<p>If you run <code>bundle package</code> under C Ruby, bundler will retrieve -the version of <code>nokogiri</code> for the <code>"ruby"</code> platform. If you deploy -to JRuby and run <code>bundle install</code>, bundler is forced to check to -see whether a <code>"java"</code> platformed <code>nokogiri</code> exists.</p> - -<p>Even though the <code>nokogiri</code> gem for the Ruby platform is -<em>technically</em> acceptable on JRuby, it actually has a C extension -that does not run on JRuby. As a result, bundler will, by default, -still connect to <code>rubygems.org</code> to check whether it has a version -of one of your gems more specific to your platform.</p> - -<p>This problem is also not just limited to the <code>"java"</code> platform. -A similar (common) problem can happen when developing on Windows -and deploying to Linux, or even when developing on OSX and -deploying to Linux.</p> - -<p>If you know for sure that the gems packaged in <code>vendor/cache</code> -are appropriate for the platform you are on, you can run -<code>bundle install --local</code> to skip checking for more appropriate -gems, and just use the ones in <code>vendor/cache</code>.</p> - -<p>One way to be sure that you have the right platformed versions -of all your gems is to run <code>bundle package</code> on an identical -machine and check in the gems. For instance, you can run -<code>bundle package</code> on an identical staging box during your -staging process, and check in the <code>vendor/cache</code> before -deploying to production.</p> - - - <ol class='man-decor man-foot man foot'> - <li class='tl'></li> - <li class='tc'>June 2014</li> - <li class='tr'>bundle-package(1)</li> - </ol> - - </div> -</body> -</html> diff --git a/man/bundle-platform.1.html b/man/bundle-platform.1.html deleted file mode 100644 index bf0b53ac07..0000000000 --- a/man/bundle-platform.1.html +++ /dev/null @@ -1,126 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta http-equiv='content-type' value='text/html;charset=utf8'> - <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'> - <title>bundle-platform(1) - Displays platform compatibility information</title> - <style type='text/css' media='all'> - /* style: man */ - body#manpage {margin:0} - .mp {max-width:100ex;padding:0 9ex 1ex 4ex} - .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0} - .mp h2 {margin:10px 0 0 0} - .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex} - .mp h3 {margin:0 0 0 4ex} - .mp dt {margin:0;clear:left} - .mp dt.flush {float:left;width:8ex} - .mp dd {margin:0 0 0 9ex} - .mp h1,.mp h2,.mp h3,.mp h4 {clear:left} - .mp pre {margin-bottom:20px} - .mp pre+h2,.mp pre+h3 {margin-top:22px} - .mp h2+pre,.mp h3+pre {margin-top:5px} - .mp img {display:block;margin:auto} - .mp h1.man-title {display:none} - .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143} - .mp h2 {font-size:16px;line-height:1.25} - .mp h1 {font-size:20px;line-height:2} - .mp {text-align:justify;background:#fff} - .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211} - .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201} - .mp u {text-decoration:underline} - .mp code,.mp strong,.mp b {font-weight:bold;color:#131211} - .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none} - .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff} - .mp b.man-ref {font-weight:normal;color:#434241} - .mp pre {padding:0 4ex} - .mp pre code {font-weight:normal;color:#434241} - .mp h2+pre,h3+pre {padding-left:0} - ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px} - ol.man-decor {width:100%} - ol.man-decor li.tl {text-align:left} - ol.man-decor li.tc {text-align:center;letter-spacing:4px} - ol.man-decor li.tr {text-align:right;float:right} - </style> -</head> -<!-- - The following styles are deprecated and will be removed at some point: - div#man, div#man ol.man, div#man ol.head, div#man ol.man. - - The .man-page, .man-decor, .man-head, .man-foot, .man-title, and - .man-navigation should be used instead. ---> -<body id='manpage'> - <div class='mp' id='man'> - - <div class='man-navigation' style='display:none'> - <a href="#NAME">NAME</a> - <a href="#SYNOPSIS">SYNOPSIS</a> - <a href="#DESCRIPTION">DESCRIPTION</a> - <a href="#OPTIONS">OPTIONS</a> - </div> - - <ol class='man-decor man-head man head'> - <li class='tl'>bundle-platform(1)</li> - <li class='tc'></li> - <li class='tr'>bundle-platform(1)</li> - </ol> - - <h2 id="NAME">NAME</h2> -<p class="man-name"> - <code>bundle-platform</code> - <span class="man-whatis">Displays platform compatibility information</span> -</p> - -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p><code>bundle platform</code> [--ruby]</p> - -<h2 id="DESCRIPTION">DESCRIPTION</h2> - -<p><code>platform</code> will display information from your Gemfile, Gemfile.lock, and Ruby -VM about your platform.</p> - -<p>For instance, using this <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>:</p> - -<pre><code>source "https://rubygems.org" - -ruby "1.9.3" - -gem "rack" -</code></pre> - -<p>If you run <code>bundle platform</code> on Ruby 1.9.3, it will display the following output:</p> - -<pre><code>Your platform is: x86_64-linux - -Your app has gems that work on these platforms: -* ruby - -Your Gemfile specifies a Ruby version requirement: -* ruby 1.9.3 - -Your current platform satisfies the Ruby version requirement. -</code></pre> - -<p><code>platform</code> will list all the platforms in your <code>Gemfile.lock</code> as well as the -<code>ruby</code> directive if applicable from your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>. It will also let you know -if the <code>ruby</code> directive requirement has been met. If <code>ruby</code> directive doesn't -match the running Ruby VM, it will tell you what part does not.</p> - -<h2 id="OPTIONS">OPTIONS</h2> - -<dl> -<dt class="flush"><code>--ruby</code></dt><dd>It will just display the ruby directive information, so you don't have to -parse it from the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>.</dd> -</dl> - - - - <ol class='man-decor man-foot man foot'> - <li class='tl'></li> - <li class='tc'>June 2014</li> - <li class='tr'>bundle-platform(1)</li> - </ol> - - </div> -</body> -</html> diff --git a/man/bundle-update.1.html b/man/bundle-update.1.html deleted file mode 100644 index f031442188..0000000000 --- a/man/bundle-update.1.html +++ /dev/null @@ -1,262 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta http-equiv='content-type' value='text/html;charset=utf8'> - <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'> - <title>bundle-update(1) - Update your gems to the latest available versions</title> - <style type='text/css' media='all'> - /* style: man */ - body#manpage {margin:0} - .mp {max-width:100ex;padding:0 9ex 1ex 4ex} - .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0} - .mp h2 {margin:10px 0 0 0} - .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex} - .mp h3 {margin:0 0 0 4ex} - .mp dt {margin:0;clear:left} - .mp dt.flush {float:left;width:8ex} - .mp dd {margin:0 0 0 9ex} - .mp h1,.mp h2,.mp h3,.mp h4 {clear:left} - .mp pre {margin-bottom:20px} - .mp pre+h2,.mp pre+h3 {margin-top:22px} - .mp h2+pre,.mp h3+pre {margin-top:5px} - .mp img {display:block;margin:auto} - .mp h1.man-title {display:none} - .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143} - .mp h2 {font-size:16px;line-height:1.25} - .mp h1 {font-size:20px;line-height:2} - .mp {text-align:justify;background:#fff} - .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211} - .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201} - .mp u {text-decoration:underline} - .mp code,.mp strong,.mp b {font-weight:bold;color:#131211} - .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none} - .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff} - .mp b.man-ref {font-weight:normal;color:#434241} - .mp pre {padding:0 4ex} - .mp pre code {font-weight:normal;color:#434241} - .mp h2+pre,h3+pre {padding-left:0} - ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px} - ol.man-decor {width:100%} - ol.man-decor li.tl {text-align:left} - ol.man-decor li.tc {text-align:center;letter-spacing:4px} - ol.man-decor li.tr {text-align:right;float:right} - </style> -</head> -<!-- - The following styles are deprecated and will be removed at some point: - div#man, div#man ol.man, div#man ol.head, div#man ol.man. - - The .man-page, .man-decor, .man-head, .man-foot, .man-title, and - .man-navigation should be used instead. ---> -<body id='manpage'> - <div class='mp' id='man'> - - <div class='man-navigation' style='display:none'> - <a href="#NAME">NAME</a> - <a href="#SYNOPSIS">SYNOPSIS</a> - <a href="#DESCRIPTION">DESCRIPTION</a> - <a href="#OPTIONS">OPTIONS</a> - <a href="#UPDATING-ALL-GEMS">UPDATING ALL GEMS</a> - <a href="#UPDATING-A-LIST-OF-GEMS">UPDATING A LIST OF GEMS</a> - <a href="#OVERLAPPING-DEPENDENCIES">OVERLAPPING DEPENDENCIES</a> - <a href="#RECOMMENDED-WORKFLOW">RECOMMENDED WORKFLOW</a> - </div> - - <ol class='man-decor man-head man head'> - <li class='tl'>bundle-update(1)</li> - <li class='tc'></li> - <li class='tr'>bundle-update(1)</li> - </ol> - - <h2 id="NAME">NAME</h2> -<p class="man-name"> - <code>bundle-update</code> - <span class="man-whatis">Update your gems to the latest available versions</span> -</p> - -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p><code>bundle update</code> <var>*gems</var> [--source=NAME]</p> - -<h2 id="DESCRIPTION">DESCRIPTION</h2> - -<p>Update the gems specified (all gems, if none are specified), ignoring -the previously installed gems specified in the <code>Gemfile.lock</code>. In -general, you should use <a href="bundle-install.1.html">bundle install(1)</a> to install the same exact -gems and versions across machines.</p> - -<p>You would use <code>bundle update</code> to explicitly update the version of a -gem.</p> - -<h2 id="OPTIONS">OPTIONS</h2> - -<dl> -<dt><code>--source=<name></code></dt><dd>The name of a <code>:git</code> or <code>:path</code> source used in the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>. For -instance, with a <code>:git</code> source of <code>http://github.com/rails/rails.git</code>, -you would call <code>bundle update --source rails</code></dd> -</dl> - - -<h2 id="UPDATING-ALL-GEMS">UPDATING ALL GEMS</h2> - -<p>If you run <code>bundle update</code> with no parameters, bundler will ignore -any previously installed gems and resolve all dependencies again -based on the latest versions of all gems available in the sources.</p> - -<p>Consider the following <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>:</p> - -<pre><code>source "https://rubygems.org" - -gem "rails", "3.0.0.rc" -gem "nokogiri" -</code></pre> - -<p>When you run <a href="bundle-install.1.html">bundle install(1)</a> the first time, bundler will resolve -all of the dependencies, all the way down, and install what you need:</p> - -<pre><code>Fetching source index for https://rubygems.org/ -Installing rake (10.0.2) -Installing abstract (1.0.0) -Installing activesupport (3.0.0.rc) -Installing builder (2.1.2) -Installing i18n (0.4.1) -Installing activemodel (3.0.0.rc) -Installing erubis (2.6.6) -Installing rack (1.2.1) -Installing rack-mount (0.6.9) -Installing rack-test (0.5.4) -Installing tzinfo (0.3.22) -Installing actionpack (3.0.0.rc) -Installing mime-types (1.16) -Installing polyglot (0.3.1) -Installing treetop (1.4.8) -Installing mail (2.2.5) -Installing actionmailer (3.0.0.rc) -Installing arel (0.4.0) -Installing activerecord (3.0.0.rc) -Installing activeresource (3.0.0.rc) -Installing bundler (1.0.0.rc.3) -Installing nokogiri (1.4.3.1) with native extensions -Installing thor (0.14.0) -Installing railties (3.0.0.rc) -Installing rails (3.0.0.rc) - -Your bundle is complete! Use `bundle show [gemname]` to see where a bundled gem is installed. -</code></pre> - -<p>As you can see, even though you have just two gems in the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>, your application -actually needs 25 different gems in order to run. Bundler remembers the exact versions -it installed in <code>Gemfile.lock</code>. The next time you run <a href="bundle-install.1.html">bundle install(1)</a>, bundler skips -the dependency resolution and installs the same gems as it installed last time.</p> - -<p>After checking in the <code>Gemfile.lock</code> into version control and cloning it on another -machine, running <a href="bundle-install.1.html">bundle install(1)</a> will <em>still</em> install the gems that you installed -last time. You don't need to worry that a new release of <code>erubis</code> or <code>mail</code> changes -the gems you use.</p> - -<p>However, from time to time, you might want to update the gems you are using to the -newest versions that still match the gems in your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>.</p> - -<p>To do this, run <code>bundle update</code>, which will ignore the <code>Gemfile.lock</code>, and resolve -all the dependencies again. Keep in mind that this process can result in a significantly -different set of the 25 gems, based on the requirements of new gems that the gem -authors released since the last time you ran <code>bundle update</code>.</p> - -<h2 id="UPDATING-A-LIST-OF-GEMS">UPDATING A LIST OF GEMS</h2> - -<p>Sometimes, you want to update a single gem in the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>, and leave the rest of the -gems that you specified locked to the versions in the <code>Gemfile.lock</code>.</p> - -<p>For instance, in the scenario above, imagine that <code>nokogiri</code> releases version <code>1.4.4</code>, and -you want to update it <em>without</em> updating Rails and all of its dependencies. To do this, -run <code>bundle update nokogiri</code>.</p> - -<p>Bundler will update <code>nokogiri</code> and any of its dependencies, but leave alone Rails and -its dependencies.</p> - -<h2 id="OVERLAPPING-DEPENDENCIES">OVERLAPPING DEPENDENCIES</h2> - -<p>Sometimes, multiple gems declared in your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> are satisfied by the same -second-level dependency. For instance, consider the case of <code>thin</code> and -<code>rack-perftools-profiler</code>.</p> - -<pre><code>source "https://rubygems.org" - -gem "thin" -gem "rack-perftools-profiler" -</code></pre> - -<p>The <code>thin</code> gem depends on <code>rack >= 1.0</code>, while <code>rack-perftools-profiler</code> depends -on <code>rack ~> 1.0</code>. If you run bundle install, you get:</p> - -<pre><code>Fetching source index for https://rubygems.org/ -Installing daemons (1.1.0) -Installing eventmachine (0.12.10) with native extensions -Installing open4 (1.0.1) -Installing perftools.rb (0.4.7) with native extensions -Installing rack (1.2.1) -Installing rack-perftools_profiler (0.0.2) -Installing thin (1.2.7) with native extensions -Using bundler (1.0.0.rc.3) -</code></pre> - -<p>In this case, the two gems have their own set of dependencies, but they share -<code>rack</code> in common. If you run <code>bundle update thin</code>, bundler will update <code>daemons</code>, -<code>eventmachine</code> and <code>rack</code>, which are dependencies of <code>thin</code>, but not <code>open4</code> or -<code>perftools.rb</code>, which are dependencies of <code>rack-perftools_profiler</code>. Note that -<code>bundle update thin</code> will update <code>rack</code> even though it's <em>also</em> a dependency of -<code>rack-perftools_profiler</code>.</p> - -<p><code>In short</code>, when you update a gem using <code>bundle update</code>, bundler will update all -dependencies of that gem, including those that are also dependencies of another gem.</p> - -<p>In this scenario, updating the <code>thin</code> version manually in the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>, -and then running <a href="bundle-install.1.html">bundle install(1)</a> will only update <code>daemons</code> and <code>eventmachine</code>, -but not <code>rack</code>. For more information, see the <code>CONSERVATIVE UPDATING</code> section -of <a href="bundle-install.1.html">bundle install(1)</a>.</p> - -<h2 id="RECOMMENDED-WORKFLOW">RECOMMENDED WORKFLOW</h2> - -<p>In general, when working with an application managed with bundler, you should -use the following workflow:</p> - -<ul> -<li><p>After you create your <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> for the first time, run</p> - -<p> $ bundle install</p></li> -<li><p>Check the resulting <code>Gemfile.lock</code> into version control</p> - -<p> $ git add Gemfile.lock</p></li> -<li><p>When checking out this repository on another development machine, run</p> - -<p> $ bundle install</p></li> -<li><p>When checking out this repository on a deployment machine, run</p> - -<p> $ bundle install --deployment</p></li> -<li><p>After changing the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> to reflect a new or update dependency, run</p> - -<p> $ bundle install</p></li> -<li><p>Make sure to check the updated <code>Gemfile.lock</code> into version control</p> - -<p> $ git add Gemfile.lock</p></li> -<li><p>If <a href="bundle-install.1.html">bundle install(1)</a> reports a conflict, manually update the specific -gems that you changed in the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a></p> - -<p> $ bundle update rails thin</p></li> -<li><p>If you want to update all the gems to the latest possible versions that -still match the gems listed in the <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a>, run</p> - -<p> $ bundle update</p></li> -</ul> - - - - <ol class='man-decor man-foot man foot'> - <li class='tl'></li> - <li class='tc'>June 2014</li> - <li class='tr'>bundle-update(1)</li> - </ol> - - </div> -</body> -</html> diff --git a/man/bundle.1.html b/man/bundle.1.html deleted file mode 100644 index e1a0577d50..0000000000 --- a/man/bundle.1.html +++ /dev/null @@ -1,152 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta http-equiv='content-type' value='text/html;charset=utf8'> - <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'> - <title>bundle(1) - Ruby Dependency Management</title> - <style type='text/css' media='all'> - /* style: man */ - body#manpage {margin:0} - .mp {max-width:100ex;padding:0 9ex 1ex 4ex} - .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0} - .mp h2 {margin:10px 0 0 0} - .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex} - .mp h3 {margin:0 0 0 4ex} - .mp dt {margin:0;clear:left} - .mp dt.flush {float:left;width:8ex} - .mp dd {margin:0 0 0 9ex} - .mp h1,.mp h2,.mp h3,.mp h4 {clear:left} - .mp pre {margin-bottom:20px} - .mp pre+h2,.mp pre+h3 {margin-top:22px} - .mp h2+pre,.mp h3+pre {margin-top:5px} - .mp img {display:block;margin:auto} - .mp h1.man-title {display:none} - .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143} - .mp h2 {font-size:16px;line-height:1.25} - .mp h1 {font-size:20px;line-height:2} - .mp {text-align:justify;background:#fff} - .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211} - .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201} - .mp u {text-decoration:underline} - .mp code,.mp strong,.mp b {font-weight:bold;color:#131211} - .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none} - .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff} - .mp b.man-ref {font-weight:normal;color:#434241} - .mp pre {padding:0 4ex} - .mp pre code {font-weight:normal;color:#434241} - .mp h2+pre,h3+pre {padding-left:0} - ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px} - ol.man-decor {width:100%} - ol.man-decor li.tl {text-align:left} - ol.man-decor li.tc {text-align:center;letter-spacing:4px} - ol.man-decor li.tr {text-align:right;float:right} - </style> -</head> -<!-- - The following styles are deprecated and will be removed at some point: - div#man, div#man ol.man, div#man ol.head, div#man ol.man. - - The .man-page, .man-decor, .man-head, .man-foot, .man-title, and - .man-navigation should be used instead. ---> -<body id='manpage'> - <div class='mp' id='man'> - - <div class='man-navigation' style='display:none'> - <a href="#NAME">NAME</a> - <a href="#SYNOPSIS">SYNOPSIS</a> - <a href="#DESCRIPTION">DESCRIPTION</a> - <a href="#OPTIONS">OPTIONS</a> - <a href="#BUNDLE-COMMANDS">BUNDLE COMMANDS</a> - <a href="#PRIMARY-COMMANDS">PRIMARY COMMANDS</a> - <a href="#UTILITIES">UTILITIES</a> - <a href="#OBSOLETE">OBSOLETE</a> - </div> - - <ol class='man-decor man-head man head'> - <li class='tl'>bundle(1)</li> - <li class='tc'></li> - <li class='tr'>bundle(1)</li> - </ol> - - <h2 id="NAME">NAME</h2> -<p class="man-name"> - <code>bundle</code> - <span class="man-whatis">Ruby Dependency Management</span> -</p> - -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p><code>bundle</code> COMMAND [--no-color] [--verbose] [ARGS]</p> - -<h2 id="DESCRIPTION">DESCRIPTION</h2> - -<p>Bundler manages an <code>application's dependencies</code> through its entire life -across many machines systematically and repeatably.</p> - -<p>See <a href="http://bundler.io">the bundler website</a> for information on getting -started, and <a class="man-ref" href="gemfile.5.html">Gemfile<span class="s">(5)</span></a> for more information on the <code>Gemfile</code> format.</p> - -<h2 id="OPTIONS">OPTIONS</h2> - -<dl> -<dt><code>--no-color</code></dt><dd><p>Prints all output without color</p></dd> -<dt><code>--verbose</code></dt><dd><p>Prints out additional logging information</p></dd> -</dl> - - -<h2 id="BUNDLE-COMMANDS">BUNDLE COMMANDS</h2> - -<p>We divide <code>bundle</code> subcommands into primary commands and utilities.</p> - -<h2 id="PRIMARY-COMMANDS">PRIMARY COMMANDS</h2> - -<dl> -<dt><a href="bundle-install.1.html">bundle install(1)</a></dt><dd><p>Install the gems specified by the <code>Gemfile</code> or <code>Gemfile.lock</code></p></dd> -<dt><a href="bundle-update.1.html">bundle update(1)</a></dt><dd><p>Update dependencies to their latest versions</p></dd> -<dt><a href="bundle-package.1.html">bundle package(1)</a></dt><dd><p>Package the .gem files required by your application into the -<code>vendor/cache</code> directory</p></dd> -<dt><a href="bundle-exec.1.html">bundle exec(1)</a></dt><dd><p>Execute a script in the context of the current bundle</p></dd> -<dt><a href="bundle-config.1.html">bundle config(1)</a></dt><dd><p>Specify and read configuration options for bundler</p></dd> -<dt><code>bundle help(1)</code></dt><dd><p>Displays detailed help for each subcommand</p></dd> -</dl> - - -<h2 id="UTILITIES">UTILITIES</h2> - -<dl> -<dt><code>bundle check(1)</code></dt><dd><p>Determine whether the requirements for your application are installed -and available to bundler</p></dd> -<dt><code>bundle list(1)</code></dt><dd><p>Show all of the gems in the current bundle</p></dd> -<dt><code>bundle show(1)</code></dt><dd><p>Show the source location of a particular gem in the bundle</p></dd> -<dt><code>bundle outdated(1)</code></dt><dd><p>Show all of the outdated gems in the current bundle</p></dd> -<dt><code>bundle console(1)</code></dt><dd><p>Start an IRB session in the context of the current bundle</p></dd> -<dt><code>bundle open(1)</code></dt><dd><p>Open an installed gem in the editor</p></dd> -<dt><code>bundle viz(1)</code></dt><dd><p>Generate a visual representation of your dependencies</p></dd> -<dt><code>bundle init(1)</code></dt><dd><p>Generate a simple <code>Gemfile</code>, placed in the current directory</p></dd> -<dt><code>bundle gem(1)</code></dt><dd><p>Create a simple gem, suitable for development with bundler</p></dd> -<dt><a href="bundle-platform.1.html">bundle platform(1)</a></dt><dd><p>Displays platform compatibility information</p></dd> -<dt><code>bundle clean(1)</code></dt><dd><p>Cleans up unused gems in your bundler directory</p></dd> -</dl> - - -<h2 id="OBSOLETE">OBSOLETE</h2> - -<p>These commands are obsolete and should no longer be used</p> - -<ul> -<li><code>bundle lock(1)</code></li> -<li><code>bundle unlock(1)</code></li> -<li><code>bundle cache(1)</code></li> -</ul> - - - - <ol class='man-decor man-foot man foot'> - <li class='tl'></li> - <li class='tc'>June 2014</li> - <li class='tr'>bundle(1)</li> - </ol> - - </div> -</body> -</html> diff --git a/man/gemfile.5.html b/man/gemfile.5.html deleted file mode 100644 index e6a1701f43..0000000000 --- a/man/gemfile.5.html +++ /dev/null @@ -1,446 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta http-equiv='content-type' value='text/html;charset=utf8'> - <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'> - <title>Gemfile(5) - A format for describing gem dependencies for Ruby programs</title> - <style type='text/css' media='all'> - /* style: man */ - body#manpage {margin:0} - .mp {max-width:100ex;padding:0 9ex 1ex 4ex} - .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0} - .mp h2 {margin:10px 0 0 0} - .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex} - .mp h3 {margin:0 0 0 4ex} - .mp dt {margin:0;clear:left} - .mp dt.flush {float:left;width:8ex} - .mp dd {margin:0 0 0 9ex} - .mp h1,.mp h2,.mp h3,.mp h4 {clear:left} - .mp pre {margin-bottom:20px} - .mp pre+h2,.mp pre+h3 {margin-top:22px} - .mp h2+pre,.mp h3+pre {margin-top:5px} - .mp img {display:block;margin:auto} - .mp h1.man-title {display:none} - .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143} - .mp h2 {font-size:16px;line-height:1.25} - .mp h1 {font-size:20px;line-height:2} - .mp {text-align:justify;background:#fff} - .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211} - .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201} - .mp u {text-decoration:underline} - .mp code,.mp strong,.mp b {font-weight:bold;color:#131211} - .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none} - .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff} - .mp b.man-ref {font-weight:normal;color:#434241} - .mp pre {padding:0 4ex} - .mp pre code {font-weight:normal;color:#434241} - .mp h2+pre,h3+pre {padding-left:0} - ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px} - ol.man-decor {width:100%} - ol.man-decor li.tl {text-align:left} - ol.man-decor li.tc {text-align:center;letter-spacing:4px} - ol.man-decor li.tr {text-align:right;float:right} - </style> -</head> -<!-- - The following styles are deprecated and will be removed at some point: - div#man, div#man ol.man, div#man ol.head, div#man ol.man. - - The .man-page, .man-decor, .man-head, .man-foot, .man-title, and - .man-navigation should be used instead. ---> -<body id='manpage'> - <div class='mp' id='man'> - - <div class='man-navigation' style='display:none'> - <a href="#NAME">NAME</a> - <a href="#SYNOPSIS">SYNOPSIS</a> - <a href="#SYNTAX">SYNTAX</a> - <a href="#SOURCES-source-">SOURCES (#source)</a> - <a href="#RUBY-ruby-">RUBY (#ruby)</a> - <a href="#GEMS-gem-">GEMS (#gem)</a> - <a href="#BLOCK-FORM-OF-GIT-PATH-GROUP-and-PLATFORMS">BLOCK FORM OF GIT, PATH, GROUP and PLATFORMS</a> - <a href="#GEMSPEC-gemspec-">GEMSPEC (#gemspec)</a> - <a href="#SOURCE-PRIORITY">SOURCE PRIORITY</a> - </div> - - <ol class='man-decor man-head man head'> - <li class='tl'>Gemfile(5)</li> - <li class='tc'></li> - <li class='tr'>Gemfile(5)</li> - </ol> - - <h2 id="NAME">NAME</h2> -<p class="man-name"> - <code>Gemfile</code> - <span class="man-whatis">A format for describing gem dependencies for Ruby programs</span> -</p> - -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p>A <code>Gemfile</code> describes the gem dependencies required to execute associated -Ruby code.</p> - -<p>Place the <code>Gemfile</code> in the root of the directory containing the associated -code. For instance, in a Rails application, place the <code>Gemfile</code> in the same -directory as the <code>Rakefile</code>.</p> - -<h2 id="SYNTAX">SYNTAX</h2> - -<p>A <code>Gemfile</code> is evaluated as Ruby code, in a context which makes available -a number of methods used to describe the gem requirements.</p> - -<h2 id="SOURCES-source-">SOURCES (#source)</h2> - -<p>At the top of the <code>Gemfile</code>, add one line for each <code>Rubygems</code> source that -might contain the gems listed in the <code>Gemfile</code>.</p> - -<pre><code>source "https://rubygems.org" -source "http://gems.github.com" -</code></pre> - -<p>Each of these _source_s <code>MUST</code> be a valid Rubygems repository. Sources are -checked for gems following the heuristics described in <a href="#SOURCE-PRIORITY" title="SOURCE PRIORITY" data-bare-link="true">SOURCE PRIORITY</a>.</p> - -<h2 id="RUBY-ruby-">RUBY (#ruby)</h2> - -<p>If your application requires a specific Ruby version or engine, specify your -requirements using the <code>ruby</code> method, with the following arguments. -All parameters are <code>OPTIONAL</code> unless otherwise specified.</p> - -<h3 id="VERSION-required-">VERSION (required)</h3> - -<p>The version of Ruby that your application requires. If your application -requires an alternate Ruby engine, such as JRuby or Rubinius, this should be -the Ruby version that the engine is compatible with.</p> - -<pre><code>ruby "1.9.3" -</code></pre> - -<h3 id="ENGINE-engine-">ENGINE (:engine)</h3> - -<p>Each application <em>may</em> specify a Ruby engine. If an engine is specified, an -engine version <em>must</em> also be specified.</p> - -<h3 id="ENGINE-VERSION-engine_version-">ENGINE VERSION (:engine_version)</h3> - -<p>Each application <em>may</em> specify a Ruby engine version. If an engine version is -specified, an engine <em>must</em> also be specified. If the engine is "ruby" the -engine version specified <em>must</em> match the Ruby version.</p> - -<pre><code>ruby "1.8.7", :engine => "jruby", :engine_version => "1.6.7" -</code></pre> - -<h3 id="PATCHLEVEL-patchlevel-">PATCHLEVEL (:patchlevel)</h3> - -<p>Each application <em>may</em> specify a Ruby patchlevel.</p> - -<pre><code>ruby "2.0.0", :patchlevel => "247" -</code></pre> - -<h2 id="GEMS-gem-">GEMS (#gem)</h2> - -<p>Specify gem requirements using the <code>gem</code> method, with the following arguments. -All parameters are <code>OPTIONAL</code> unless otherwise specified.</p> - -<h3 id="NAME-required-">NAME (required)</h3> - -<p>For each gem requirement, list a single <em>gem</em> line.</p> - -<pre><code>gem "nokogiri" -</code></pre> - -<h3 id="VERSION">VERSION</h3> - -<p>Each <em>gem</em> <code>MAY</code> have one or more version specifiers.</p> - -<pre><code>gem "nokogiri", ">= 1.4.2" -gem "RedCloth", ">= 4.1.0", "< 4.2.0" -</code></pre> - -<h3 id="REQUIRE-AS-require-">REQUIRE AS (:require)</h3> - -<p>Each <em>gem</em> <code>MAY</code> specify files that should be used when autorequiring via -<code>Bundler.require</code>. You may pass an array with multiple files or <code>true</code> if file -you want <code>required</code> has same name as <em>gem</em> or <code>false</code> to -prevent any file from being autorequired.</p> - -<pre><code>gem "redis", :require => ["redis/connection/hiredis", "redis"] -gem "webmock", :require => false -gem "debugger", :require => true -</code></pre> - -<p>The argument defaults to the name of the gem. For example, these are identical:</p> - -<pre><code>gem "nokogiri" -gem "nokogiri", :require => "nokogiri" -gem "nokogiri", :require => true -</code></pre> - -<h3 id="GROUPS-group-or-groups-">GROUPS (:group or :groups)</h3> - -<p>Each <em>gem</em> <code>MAY</code> specify membership in one or more groups. Any <em>gem</em> that does -not specify membership in any group is placed in the <code>default</code> group.</p> - -<pre><code>gem "rspec", :group => :test -gem "wirble", :groups => [:development, :test] -</code></pre> - -<p>The Bundler runtime allows its two main methods, <code>Bundler.setup</code> and -<code>Bundler.require</code>, to limit their impact to particular groups.</p> - -<pre><code># setup adds gems to Ruby's load path -Bundler.setup # defaults to all groups -require "bundler/setup" # same as Bundler.setup -Bundler.setup(:default) # only set up the _default_ group -Bundler.setup(:test) # only set up the _test_ group (but `not` _default_) -Bundler.setup(:default, :test) # set up the _default_ and _test_ groups, but no others - -# require requires all of the gems in the specified groups -Bundler.require # defaults to just the _default_ group -Bundler.require(:default) # identical -Bundler.require(:default, :test) # requires the _default_ and _test_ groups -Bundler.require(:test) # requires just the _test_ group -</code></pre> - -<p>The Bundler CLI allows you to specify a list of groups whose gems <code>bundle install</code> should -not install with the <code>--without</code> option. To specify multiple groups to ignore, specify a -list of groups separated by spaces.</p> - -<pre><code>bundle install --without test -bundle install --without development test -</code></pre> - -<p>After running <code>bundle install --without test</code>, bundler will remember that you excluded -the test group in the last installation. The next time you run <code>bundle install</code>, -without any <code>--without option</code>, bundler will recall it.</p> - -<p>Also, calling <code>Bundler.setup</code> with no parameters, or calling <code>require "bundler/setup"</code> -will setup all groups except for the ones you excluded via <code>--without</code> (since they -are obviously not available).</p> - -<p>Note that on <code>bundle install</code>, bundler downloads and evaluates all gems, in order to -create a single canonical list of all of the required gems and their dependencies. -This means that you cannot list different versions of the same gems in different -groups. For more details, see <a href="http://bundler.io/rationale.html">Understanding Bundler</a>.</p> - -<h3 id="PLATFORMS-platforms-">PLATFORMS (:platforms)</h3> - -<p>If a gem should only be used in a particular platform or set of platforms, you can -specify them. Platforms are essentially identical to groups, except that you do not -need to use the <code>--without</code> install-time flag to exclude groups of gems for other -platforms.</p> - -<p>There are a number of <code>Gemfile</code> platforms:</p> - -<dl> -<dt class="flush"><code>ruby</code></dt><dd>C Ruby (MRI) or Rubinius, but <code>NOT</code> Windows</dd> -<dt class="flush"><code>ruby_18</code></dt><dd><em>ruby</em> <code>AND</code> version 1.8</dd> -<dt class="flush"><code>ruby_19</code></dt><dd><em>ruby</em> <code>AND</code> version 1.9</dd> -<dt class="flush"><code>ruby_20</code></dt><dd><em>ruby</em> <code>AND</code> version 2.0</dd> -<dt class="flush"><code>ruby_21</code></dt><dd><em>ruby</em> <code>AND</code> version 2.1</dd> -<dt class="flush"><code>mri</code></dt><dd>Same as <em>ruby</em>, but not Rubinius</dd> -<dt class="flush"><code>mri_18</code></dt><dd><em>mri</em> <code>AND</code> version 1.8</dd> -<dt class="flush"><code>mri_19</code></dt><dd><em>mri</em> <code>AND</code> version 1.9</dd> -<dt class="flush"><code>mri_20</code></dt><dd><em>mri</em> <code>AND</code> version 2.0</dd> -<dt class="flush"><code>mri_21</code></dt><dd><em>mri</em> <code>AND</code> version 2.1</dd> -<dt class="flush"><code>rbx</code></dt><dd>Same as <em>ruby</em>, but only Rubinius (not MRI)</dd> -<dt class="flush"><code>jruby</code></dt><dd>JRuby</dd> -<dt class="flush"><code>mswin</code></dt><dd>Windows</dd> -<dt class="flush"><code>mingw</code></dt><dd>Windows 32 bit 'mingw32' platform (aka RubyInstaller)</dd> -<dt><code>mingw_18</code></dt><dd><em>mingw</em> <code>AND</code> version 1.8</dd> -<dt><code>mingw_19</code></dt><dd><em>mingw</em> <code>AND</code> version 1.9</dd> -<dt><code>mingw_20</code></dt><dd><em>mingw</em> <code>AND</code> version 2.0</dd> -<dt><code>mingw_21</code></dt><dd><em>mingw</em> <code>AND</code> version 2.1</dd> -<dt><code>x64_mingw</code></dt><dd>Windows 64 bit 'mingw32' platform (aka RubyInstaller x64)</dd> -<dt><code>x64_mingw_20</code></dt><dd><em>x64_mingw</em> <code>AND</code> version 2.0</dd> -<dt><code>x64_mingw_21</code></dt><dd><em>x64_mingw</em> <code>AND</code> version 2.1</dd> -</dl> - - -<p>As with groups, you can specify one or more platforms:</p> - -<pre><code>gem "weakling", :platforms => :jruby -gem "ruby-debug", :platforms => :mri_18 -gem "nokogiri", :platforms => [:mri_18, :jruby] -</code></pre> - -<p>All operations involving groups (<code>bundle install</code>, <code>Bundler.setup</code>, -<code>Bundler.require</code>) behave exactly the same as if any groups not -matching the current platform were explicitly excluded.</p> - -<h3 id="GIT-git-">GIT (:git)</h3> - -<p>If necessary, you can specify that a gem is located at a particular -git repository. The repository can be public (<code>http://github.com/rails/rails.git</code>) -or private (<code>git@github.com:rails/rails.git</code>). If the repository is private, -the user that you use to run <code>bundle install</code> <code>MUST</code> have the appropriate -keys available in their <code>$HOME/.ssh</code>.</p> - -<p>Git repositories are specified using the <code>:git</code> parameter. The <code>group</code>, -<code>platforms</code>, and <code>require</code> options are available and behave exactly the same -as they would for a normal gem.</p> - -<pre><code>gem "rails", :git => "git://github.com/rails/rails.git" -</code></pre> - -<p>A git repository <code>SHOULD</code> have at least one file, at the root of the -directory containing the gem, with the extension <code>.gemspec</code>. This file -<code>MUST</code> contain a valid gem specification, as expected by the <code>gem build</code> -command.</p> - -<p>If a git repository does not have a <code>.gemspec</code>, bundler will attempt to -create one, but it will not contain any dependencies, executables, or -C extension compilation instructions. As a result, it may fail to properly -integrate into your application.</p> - -<p>If a git repository does have a <code>.gemspec</code> for the gem you attached it -to, a version specifier, if provided, means that the git repository is -only valid if the <code>.gemspec</code> specifies a version matching the version -specifier. If not, bundler will print a warning.</p> - -<pre><code>gem "rails", "2.3.8", :git => "git://github.com/rails/rails.git" -# bundle install will fail, because the .gemspec in the rails -# repository's master branch specifies version 3.0.0 -</code></pre> - -<p>If a git repository does <code>not</code> have a <code>.gemspec</code> for the gem you attached -it to, a version specifier <code>MUST</code> be provided. Bundler will use this -version in the simple <code>.gemspec</code> it creates.</p> - -<p>Git repositories support a number of additional options.</p> - -<dl> -<dt><code>branch</code>, <code>tag</code>, and <code>ref</code></dt><dd>You <code>MUST</code> only specify at most one of these options. The default -is <code>:branch => "master"</code></dd> -<dt><code>submodules</code></dt><dd>Specify <code>:submodules => true</code> to cause bundler to expand any -submodules included in the git repository</dd> -</dl> - - -<p>If a git repository contains multiple <code>.gemspecs</code>, each <code>.gemspec</code> -represents a gem located at the same place in the file system as -the <code>.gemspec</code>.</p> - -<pre><code>|~rails [git root] -| |-rails.gemspec [rails gem located here] -|~actionpack -| |-actionpack.gemspec [actionpack gem located here] -|~activesupport -| |-activesupport.gemspec [activesupport gem located here] -|... -</code></pre> - -<p>To install a gem located in a git repository, bundler changes to -the directory containing the gemspec, runs <code>gem build name.gemspec</code> -and then installs the resulting gem. The <code>gem build</code> command, -which comes standard with Rubygems, evaluates the <code>.gemspec</code> in -the context of the directory in which it is located.</p> - -<h3 id="GITHUB-github-">GITHUB (:github)</h3> - -<p>If the git repository you want to use is hosted on GitHub and is public, you can use the -:github shorthand to specify just the github username and repository name (without the -trailing ".git"), separated by a slash. If both the username and repository name are the -same, you can omit one.</p> - -<pre><code>gem "rails", :github => "rails/rails" -gem "rails", :github => "rails" -</code></pre> - -<p>Are both equivalent to</p> - -<pre><code>gem "rails", :git => "git://github.com/rails/rails.git" -</code></pre> - -<p>In addition, if you wish to choose a specific branch:</p> - -<pre><code>gem "rails", :github => "rails/rails", :branch => "branch_name" -</code></pre> - -<h3 id="PATH-path-">PATH (:path)</h3> - -<p>You can specify that a gem is located in a particular location -on the file system. Relative paths are resolved relative to the -directory containing the <code>Gemfile</code>.</p> - -<p>Similar to the semantics of the <code>:git</code> option, the <code>:path</code> -option requires that the directory in question either contains -a <code>.gemspec</code> for the gem, or that you specify an explicit -version that bundler should use.</p> - -<p>Unlike <code>:git</code>, bundler does not compile C extensions for -gems specified as paths.</p> - -<pre><code>gem "rails", :path => "vendor/rails" -</code></pre> - -<h2 id="BLOCK-FORM-OF-GIT-PATH-GROUP-and-PLATFORMS">BLOCK FORM OF GIT, PATH, GROUP and PLATFORMS</h2> - -<p>The <code>:git</code>, <code>:path</code>, <code>:group</code>, and <code>:platforms</code> options may be -applied to a group of gems by using block form.</p> - -<pre><code>git "git://github.com/rails/rails.git" do - gem "activesupport" - gem "actionpack" -end - -platforms :ruby do - gem "ruby-debug" - gem "sqlite3" -end - -group :development do - gem "wirble" - gem "faker" -end -</code></pre> - -<p>In the case of the <code>git</code> block form, the <code>:ref</code>, <code>:branch</code>, <code>:tag</code>, -and <code>:submodules</code> options may be passed to the <code>git</code> method, and -all gems in the block will inherit those options.</p> - -<h2 id="GEMSPEC-gemspec-">GEMSPEC (#gemspec)</h2> - -<p>If you wish to use Bundler to help install dependencies for a gem while it is -being developed, use the <code>gemspec</code> method to pull in the dependencies listed in -the <code>.gemspec</code> file.</p> - -<p>The <code>gemspec</code> method adds any runtime dependencies as gem requirements in the -default group. It also adds development dependencies as gem requirements in the -<code>development</code> group. Finally, it adds a gem requirement on your project (<code>:path -=> '.'</code>). In conjunction with <code>Bundler.setup</code>, this allows you to require project -files in your test code as you would if the project were installed as a gem; you -need not manipulate the load path manually or require project files via relative -paths.</p> - -<p>The <code>gemspec</code> method supports optional <code>:path</code>, <code>:name</code>, and <code>:development_group</code> -options, which control where bundler looks for the <code>.gemspec</code>, what named -<code>.gemspec</code> it uses (if more than one is present), and which group development -dependencies are included in.</p> - -<h2 id="SOURCE-PRIORITY">SOURCE PRIORITY</h2> - -<p>When attempting to locate a gem to satisfy a gem requirement, -bundler uses the following priority order:</p> - -<ol> -<li> The source explicitly attached to the gem (using <code>:path</code> or <code>:git</code>)</li> -<li> For implicit gems (dependencies of explicit gems), any git or path - repository otherwise declared. This results in bundler prioritizing the - ActiveSupport gem from the Rails git repository over ones from - <code>rubygems.org</code></li> -<li> The sources specified via <code>source</code>, searching each source in your <code>Gemfile</code> - from last added to first added.</li> -</ol> - - - - <ol class='man-decor man-foot man foot'> - <li class='tl'></li> - <li class='tc'>June 2014</li> - <li class='tr'>Gemfile(5)</li> - </ol> - - </div> -</body> -</html> |