diff options
Diffstat (limited to 'v1.2')
39 files changed, 0 insertions, 6313 deletions
diff --git a/v1.2/bundle_check.html b/v1.2/bundle_check.html deleted file mode 100644 index 2c198fd6ce..0000000000 --- a/v1.2/bundle_check.html +++ /dev/null @@ -1,80 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle check</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Checks if the dependencies listed in Gemfile are satisfied by currently installed gems - </div> - <pre class="highlight plaintext">$ bundle check [--gemfile=FILE] [--path=PATH]</pre> - <div class='notes'> - <p> - Options: - </p> - <p> - <code>--gemfile</code>: Use the specified gemfile instead of Gemfile. - </p> - <p> - <code>--path</code>: Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME). Bundler will remember this value for future installs on this machine. - </p> - </div> - <div class='description'> - Check searches the local machine for each of the gems requested in the Gemfile. If - all gems are found, Bundler prints a success message and exits with a status of 0. - If not, the first missing gem is listed and Bundler exits status 1. - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_clean.html b/v1.2/bundle_clean.html deleted file mode 100644 index 42e72bb09b..0000000000 --- a/v1.2/bundle_clean.html +++ /dev/null @@ -1,72 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle clean</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Cleans up unused gems in your bundler directory - </div> - <pre class="highlight plaintext">$ bundle clean [--force]</pre> - <div class='notes'> - <p> - Options: - </p> - <p> - <code>--force</code>: forces clean even if --path is set - </p> - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_config.html b/v1.2/bundle_config.html deleted file mode 100644 index bcb56efdeb..0000000000 --- a/v1.2/bundle_config.html +++ /dev/null @@ -1,325 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle config</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Retrieve or set a configuration value - </div> - <pre class="highlight plaintext">$ bundle config [NAME [VALUE]] [--local] [--global] [--delete]</pre> - <div class='notes'> - <p> - Options: - </p> - <p> - <code>--local</code>: Get/set local configuration - </p> - <p> - <code>--global</code>: Get/set global configuration - </p> - <p> - <code>--delete</code>: Delete <code>NAME</code> value - </p> - </div> - <div class='description'> - <p> - Retrieves or sets a configuration value. If only parameter is provided, - retrieve the value. If two parameters are provided, replace the existing - value with the newly provided one. - </p> - <p> - By default, setting a configuration value sets it for all projects on - the machine. - </p> - <p> - If a global setting is superceded by local configuration, this command - will show the current value, as well as any superceded values and where - they were specified. - </p> - </div> - </div> - <div class='bullet' id='config'> - <div class='description'> - Get your bundle configuration. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle config</pre> - <div class='notes'> - 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. - </div> - </div> - </div> - <div class='bullet' id='get'> - <div class='description'> - Get your bundle configuration for <code>NAME</code> variable. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle config NAME</pre> - <div class='notes'> - Will print the value of that configuration setting for - <code>NAME</code>, and where it was set. Will print both local and - global configuration. - </div> - </div> - </div> - <div class='bullet' id='set'> - <div class='description'> - Set your bundle configuration for <code>NAME</code> variable to - <code>VALUE</code>. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle config NAME VALUE</pre> - <div class='notes'> - Will set <code>NAME</code> to <code>VALUE</code> for all bundles - executed as the current user (i.e. global setting). The configuration - will be stored in <code>~/.bundle/config</code>. If <code>NAME</code> - already is set, <code>NAME</code> will be overridden and user will be - warned. - </div> - </div> - </div> - <div class='bullet' id='global'> - <div class='description'> - Set your bundle global/user configuration for <code>NAME</code> variable - to <code>VALUE</code>. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle config --global NAME VALUE </pre> - <div class='notes'> - Works the same as the command above. - </div> - </div> - </div> - <div class='bullet' id='local'> - <div class='description'> - Set your bundle local configuration for <code>NAME</code> variable to - <code>VALUE</code>. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle config --local NAME VALUE </pre> - <div class='notes'> - Works the same as the two command above but for the local application. - The configuration will be stored in <code>app/.bundle/config</code>. - </div> - </div> - </div> - <div class='bullet' id='delete'> - <div class='description'> - Delete the configuration for <code>NAME</code> in both local and global sources. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle config --delete NAME</pre> - <div class='notes'> - Will delete the configuration for <code>NAME</code> variable in both local and global sources. Not compatible with --global or --local flag. - </div> - </div> - </div> - </div> - <h2>Build options</h2> - <div class='contents'> - <div class='bullet' id='build_options'> - <div class='description'> - <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> - <div class='how'> - <pre class="highlight plaintext">$ gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
</pre> - </div> - <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> - <div class='how'> - <pre class="highlight plaintext">$ bundle config build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config</pre> - </div> - <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> - </div> - </div> - </div> - <h2>Configuration keys</h2> - <div class='contents'> - <div class='bullet' id='configuration_keys'> - <div class='description'> - <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 - <code>bundle install</code> prevents Bundler from installing - certain groups specified in the <code>Gemfile</code>. 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 <code>bundle install</code> 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> - </div> - </div> - </div> - <h2>List of available keys</h2> - <div class='contents'> - <div class='bullet' id='available_keys'> - <div class='description'> - <p> - The following is a list of all configuration keys and their purpose. - You can learn more about their operation in - <code>bundle install</code>. - </p> - <ul> - <li> - <code>path</code> (<code>BUNDLE_PATH</code>): The location on disk - to install gems. Defaults to <code>$GEM_HOME</code> in development - and <code>vendor/bundle</code> when <code>--deployment</code> is used. - </li> - <li> - <code>frozen</code> (<code>BUNDLE_FROZEN</code>): Disallow changes to - the <code>Gemfile</code>. Defaults to <code>true</code> when - <code>--deployment</code> is used. - </li> - <li> - <code>without</code> (<code>BUNDLE_WITHOUT</code>): A - <code>:</code>-separated list of groups whose gems bundler should not - installer - </li> - <li> - <code>bin</code> (<code>BUNDLE_BIN</code>): Install executables from - gems in the bundle to the specified directory. Defaults to - <code>false</code>. - </li> - <li> - <code>gemfile</code> (<code>BUNDLE_GEMFILE</code>): 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>. - </li> - </ul> - <p> - In general, you should set these settings per-application by using the - applicable flag to the <code>bundle install</code> 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> - </div> - </div> - </div> - <h2>Local git repositories</h2> - <div class='contents'> - <div class='bullet' id='local_git_repos'> - <div class='description'> - <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 class="highlight plaintext">$ bundle config local.GEM_NAME /path/to/local/git/repository
</pre> - <p> - For example, in order to use a local Rack repository, a developer - could call: - </p> - <pre class="highlight plaintext">$ bundle config local.rack ~/Work/git/rack
</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 `Gemfile` 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> - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_console.html b/v1.2/bundle_console.html deleted file mode 100644 index f1bc81dd0e..0000000000 --- a/v1.2/bundle_console.html +++ /dev/null @@ -1,64 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle console</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Opens an IRB session with the bundle pre-loaded - </div> - <pre class="highlight plaintext">$ bundle console [GROUP]</pre> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_exec.html b/v1.2/bundle_exec.html deleted file mode 100644 index 0e5868e8a4..0000000000 --- a/v1.2/bundle_exec.html +++ /dev/null @@ -1,69 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle exec</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Run the command in context of the bundle - </div> - <pre class="highlight plaintext">$ bundle exec</pre> - <div class='description'> - Exec runs a command, providing it access to the gems in the bundle. While using - bundle exec you can require and call the bundled gems as if they were installed - into the systemwide Rubygems repository. - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_gem.html b/v1.2/bundle_gem.html deleted file mode 100644 index 75a9afdad8..0000000000 --- a/v1.2/bundle_gem.html +++ /dev/null @@ -1,72 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle gem</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Creates a skeleton for creating a rubygem - </div> - <pre class="highlight plaintext">$ bundle gem GEM [--bin or -b]</pre> - <div class='notes'> - <p> - Options: - </p> - <p> - <code>--bin or -b</code>: Generate a binary for your library. - </p> - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_init.html b/v1.2/bundle_init.html deleted file mode 100644 index 9bdd9ac342..0000000000 --- a/v1.2/bundle_init.html +++ /dev/null @@ -1,77 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle init</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Generates a Gemfile into the current working directory - </div> - <pre class="highlight plaintext">$ bundle init [--gemspec=FILE]</pre> - <div class='notes'> - <p> - Options: - </p> - <p> - <code>--gemspec</code>: Use the specified .gemspec to create the Gemfile - </p> - </div> - <div class='description'> - Init generates a default Gemfile in the current working directory. When adding a - Gemfile to a gem with a gemspec, the --gemspec option will automatically add each - dependency listed in the gemspec file to the newly created Gemfile. - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_install.html b/v1.2/bundle_install.html deleted file mode 100644 index c4ca1fc4a1..0000000000 --- a/v1.2/bundle_install.html +++ /dev/null @@ -1,176 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle install</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Make sure all dependencies in your Gemfile are available to your application. - </div> - <pre class="highlight plaintext">$ bundle install [--binstubs=PATH] [--clean] [--deployment] [--frozen]
 [--full-index] [--gemfile=FILE] [--local] [--no-cache]
 [--no-prune] [--path=PATH] [--quiet] [--shebang=STRING]
 [--standalone=ARRAY] [--system] [--without=GROUP GROUP]</pre> - <div class='notes'> - <p> - Options: - </p> - <p> - <code>--binstubs</code>: Generate bin stubs for bundled gems to ./bin - </p> - <p> - <code>--clean</code>: Run bundle clean automatically after install - </p> - <p> - <code>--deployment</code>: Install using defaults tuned for deployment environments - </p> - <p> - <code>--frozen</code>: Do not allow the Gemfile.lock to be updated after this install - </p> - <p> - <code>--full-index</code>: Use the rubygems modern index instead of the API endpoint - </p> - <p> - <code>--gemfile</code>: Use the specified gemfile instead of Gemfile - </p> - <p> - <code>--local</code>: Do not attempt to fetch gems remotely and use the gem cache instead - </p> - <p> - <code>--no-cache</code>: Don't update the existing gem cache. - </p> - <p> - <code>--no-prune</code>: Don't remove stale gems from the cache. - </p> - <p> - <code>--path</code>: Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME). Bundler will remember this value for future installs on this machine - </p> - <p> - <code>--quiet</code>: Only output warnings and errors. - </p> - <p> - <code>--shebang</code>: Specify a different shebang executable name than the default (usually 'ruby') - </p> - <p> - <code>--standalone</code>: Make a bundle that can work without the Bundler runtime - </p> - <p> - <code>--system</code>: Install to the system location ($BUNDLE_PATH or $GEM_HOME) even if the bundle was previously installed somewhere else for this application - </p> - <p> - <code>--without</code>: Exclude gems that are part of the specified named group. - </p> - </div> - <div class='notes'> - <p> - Gems will be installed to your default system location for gems. If your - system gems are stored in a root-owned location (such as in Mac OSX), - bundle will ask for your root password to install them there. - </p> - <p> - While installing gems, Bundler will check <code>vendor/cache</code> and then - your system's gems. If a gem isn't cached or installed, Bundler will try to - install it from the sources you have declared in your Gemfile. - </p> - <p> - The <code>--system</code> option is the default. Pass it to switch back after - using the <code>--path</code> option as described below. - </p> - </div> - </div> - <div class='bullet' id='path'> - <div class='description'> - Install your dependencies, even gems that are already installed - to your system gems, to a location other than your system's gem - repository. In this case, install them to <code>vendor/bundle</code>. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle install --path vendor/bundle</pre> - <div class='notes'> - Further <code>bundle</code> commands or calls to <code>Bundler.setup</code> or - <code>Bundler.require</code> will remember this location. - </div> - <a href="/v1.2/bundler_setup.html">Learn More: Bundler.setup</a> - <a href="/v1.2/groups.html">Learn More: Bundler.require</a> - </div> - </div> - <div class='bullet' id='without'> - <div class='description'> - Install all dependencies except those in groups that are explicitly excluded. - </div> - <pre class="highlight plaintext">$ bundle install --without development test</pre> - <a href="/v1.2/groups.html">Learn More: Groups</a> - </div> - <div class='bullet' id='deployment'> - <div class='description'> - Install all dependencies on to a production server. - Do <b>not</b> use this flag on a development machine. - </div> - <pre class="highlight plaintext">$ bundle install --deployment</pre> - <div class='notes'> - <p> - The <code>--deployment</code> flag activates a number of deployment-friendly - conventions: - </p> - <ul> - <li>Isolate all gems into <code>vendor/bundle</code></li> - <li>Require an up-to-date <code>Gemfile.lock</code></li> - <li> - If <code>bundle package</code> was run, do not fetch gems - from rubygems.org. Instead, only use gems in the checked - in <code>vendor/cache</code> - </li> - </ul> - </div> - <a href="/v1.2/deploying.html">Learn More: Deploying</a> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_open.html b/v1.2/bundle_open.html deleted file mode 100644 index dcc4daa153..0000000000 --- a/v1.2/bundle_open.html +++ /dev/null @@ -1,64 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle open</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Opens the source directory of the given bundled gem - </div> - <pre class="highlight plaintext">$ bundle open GEM</pre> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_outdated.html b/v1.2/bundle_outdated.html deleted file mode 100644 index 8be78de7f5..0000000000 --- a/v1.2/bundle_outdated.html +++ /dev/null @@ -1,83 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle outdated</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - List installed gems with newer versions available - </div> - <pre class="highlight plaintext">$ bundle outdated [GEM] [--local] [--pre] [--source]</pre> - <div class='notes'> - <p> - Options: - </p> - <p> - <code>--local</code>: Do not attempt to fetch gems remotely and use the gem cache instead - </p> - <p> - <code>--pre</code>: Check for newer pre-release gems - </p> - <p> - <code>--source</code>: Check against a specific source - </p> - </div> - <div class='description'> - Outdated lists the names and versions of gems that have a newer version available - in the given source. Calling outdated with [GEM [GEM]] will only check for newer - versions of the given gems. By default, available prerelease gems will be ignored. - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_package.html b/v1.2/bundle_package.html deleted file mode 100644 index e4f4333152..0000000000 --- a/v1.2/bundle_package.html +++ /dev/null @@ -1,132 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle package</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Locks and then caches the gems into <code>./vendor/cache</code>. - </div> - <pre class="highlight plaintext">$ bundle package [--no-prune] [--all]</pre> - <div class='notes'> - <p> - Options: - </p> - <p> - <code>--no-prune</code>: Don't remove stale gems from the cache. - </p> - <p> - <code>--all</code>: package <code>:git</code>, <code>:path</code>, and <code>.gem</code> dependencies. Once used, the <code>--all</code> option will be remembered. - </p> - </div> - <div class='description'> - <p> - The package command will copy the <code>.gem</code> files for your gems in the - bundle into <code>./vendor/cache</code>. Afterward, when you run <code>bundle install</code>, - Bundler will use the gems in the cache in preference to the ones on rubygems.org. - </p> - <p> - Additionally, if you then check that directory into your source control repository, - others who check out your source will be able to install the bundle without having - to download any additional gems. - </p> - </div> - </div> - <div class='bullet'> - <div class='description'> - Lock and cache gems from RubyGems into <code>./vendor/cache</code>. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle package
</pre> - </div> - <div class='notes'> - <p> - By default, if you simply run <code>bundle install</code> after running - <code>bundle package</code>, Bundler will still connect to rubygems.org to check - whether a platform-specific gem exists for any of the gems in <code>vendor/cache</code>. - </p> - <p> - This behavior can be avoided by instead running <code>bundle install --local</code>. - Note that this requires you to have the correctly platformed version for all of your gems - already cached. The easiest way to achieve this is to run <code>bundle package</code> - on an identical machine and then check in those vendored gems. - </p> - </div> - </div> - <div class='bullet' id='no-prune'> - <div class='description'> - Lock and cache gems from RubyGems into <code>./vendor/cache</code>, and don't remove any stale gems from the existing cache. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle package --no-prune
</pre> - </div> - </div> - <div class='bullet' id='all'> - <div class='description'> - Lock and cache all gems into <code>./vendor/cache</code>, including <code>:git</code>, <code>:path</code>, and <code>.gem</code> dependencies. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle package --all</pre> - </div> - <div class='notes'> - <p> - Once used, the <code>--all</code> option will be remembered. - </p> - <p> - This will be the default on Bundler 2.0. - </p> - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_platform.html b/v1.2/bundle_platform.html deleted file mode 100644 index f71da9a918..0000000000 --- a/v1.2/bundle_platform.html +++ /dev/null @@ -1,88 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle platform</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Displays platform compatibility information - </div> - <pre class="highlight plaintext">$ bundle platform [--ruby]</pre> - <div class='notes'> - <p> - Options: - </p> - <p> - <code>--ruby</code>: only display ruby related platform information - </p> - </div> - </div> - <div class='bullet'> - <div class='description'> - When not passed any options, platform will display information from your <code>Gemfile</code>, <code>Gemfile.lock</code>, and Ruby VM about your platform. You'll see output like the following: - </div> - <pre class="highlight plaintext">$ bundle platform
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.</pre> - <div class='description'> - When the <code>ruby</code> directive doesn't match the running Ruby VM, it will tell you what part does not. - </div> - <pre class="highlight plaintext">Your Ruby version is 1.9.3, but your Gemfile specified 1.8.7
</pre> - </div> - <div class='bullet' id='ruby'> - <div class='description'> - When using the <code>--ruby</code> flag, it will just display the <code>ruby</code> directive information, so you don't have to parse it from the Gemfile. - </div> - <pre class="highlight plaintext">$ bundle platform --ruby
ruby 1.9.3 (jruby 1.6.7)</pre> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_show.html b/v1.2/bundle_show.html deleted file mode 100644 index 4415928ab3..0000000000 --- a/v1.2/bundle_show.html +++ /dev/null @@ -1,76 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle show</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Shows all gems that are part of the bundle, or the path to a given gem - </div> - <pre class="highlight plaintext">$ bundle show [GEM] [--paths]</pre> - <div class='notes'> - <p> - Options: - </p> - <p> - <code>--paths</code>: List the paths of all gems that are required by your Gemfile. - </p> - </div> - <div class='description'> - Show lists the names and versions of all gems that are required by your Gemfile. - Calling show with [GEM] will list the exact location of that gem on your machine. - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_update.html b/v1.2/bundle_update.html deleted file mode 100644 index cefbc25ade..0000000000 --- a/v1.2/bundle_update.html +++ /dev/null @@ -1,272 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle update</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Update the current environment - </div> - <pre class="highlight plaintext">$ bundle update [GEM] [--local] [--source=SOURCE]</pre> - <div class='notes'> - <p> - Options: - </p> - <p> - <code>--local</code>: Do not attempt to fetch gems remotely and use - the gem cache instead - </p> - <p> - <code>--source</code>: Update a specific source (and all gems - associated with it) - </p> - </div> - <div class='description'> - 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 <code>bundle install</code> to install the same - exact gems and versions across machines. - You would use <code>bundle update</code> to explicitly update the version - of a gem. - </div> - </div> - <div class='bullet'> - <div class='description'> - Update the current environment. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle update</pre> - </div> - <div class='notes'> - 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. - </div> - </div> - <div class='bullet' id='source'> - <div class='description'> - Update a specific source (and all gems associated with it) - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle update --source=SOURCE</pre> - </div> - <div class='notes'> - The name of a <code>:git</code> or <code>:path</code> source used in the - <code>Gemfile</code>. 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>. - </div> - </div> - </div> - <h2>Update all gems</h2> - <div class='contents'> - <div class='bullet' id='update_all_extended'> - <div class='description'> - <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 <code>Gemfile</code>: - <pre class="highlight ruby"><span class="n">source</span> <span class="s1">'http://rubygems.org'</span>
<span class="n">gem</span> <span class="s1">'rails'</span><span class="p">,</span> <span class="s1">'3.0.0.rc'</span>
<span class="n">gem</span> <span class="s1">'nokogiri'</span></pre> - </p> - <p> - When you run <code>bundle install</code> the first time, bundler will - resolve all of the dependencies, all the way down, and install what you - need: - <pre class="highlight plaintext">Fetching source index for http://rubygems.org/
Installing rake (0.8.7)
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.</pre> - </p> - <p> - As you can see, even though you have just two gems in the - <code>Gemfile</code>, 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 - <code>bundle install</code>, 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 <code>bundle install</code> will - _still_ 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 - <code>Gemfile</code>. - </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> - </div> - </div> - </div> - <h2>Update a list of gems.</h2> - <div class='contents'> - <div class='bullet' id='update_list_of_gems'> - <div class='description'> - <p> - Sometimes, you want to update a single gem in the <code>Gemfile</code>, - 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 _without_ updating Rails and all of its dependencies. To - do this, run - <pre class="highlight plaintext">bundle update nokogiri
</pre> - </p> - <p> - Bundler will update <code>nokogiri</code> and any of its dependencies, - but leave alone Rails and its dependencies. - </p> - </div> - </div> - </div> - <h2>Overlapping dependencies</h2> - <div class='contents'> - <div class='bullet' id='overlapping_dependencies'> - <div class='description'> - <p> - Sometimes, multiple gems declared in your <code>Gemfile</code> are - satisfied by the same second-level dependency. For instance, consider the - case of <code>thin</code> and <code>rack-perftools-profiler</code>. - <pre class="highlight ruby"><span class="n">source</span> <span class="s1">'http://rubygems.org'</span>

<span class="n">gem</span> <span class="s1">'thin'</span>
<span class="n">gem</span> <span class="s1">'rack-perftools-profiler'</span>
</pre> - </p> - <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: - <pre class="highlight plaintext">Fetching source index for http://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)
</pre> - </p> - <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 _also_ a dependency of <code>rack-perftools_profiler</code>. - </p> - <p> - In short, 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 - <code>Gemfile</code>, and then running <code>bundle install</code> will - only update <code>daemons</code> and <code>eventmachine</code>, but not - <code>rack</code>. - </p> - </div> - </div> - </div> - <h2>Recommended workflow</h2> - <div class='contents'> - <div class='bullet' id='recommended_workflow'> - <div class='description'> - <p> - In general, when working with an application managed with bundler, you - should use the following workflow: - </p> - <p> - After you create your <code>Gemfile</code> for the first time, run - <pre class="highlight plaintext">$ bundle install</pre> - </p> - <p> - Check the resulting <code>Gemfile.lock</code> into version control - <pre class="highlight plaintext">$ git add Gemfile.lock</pre> - </p> - <p> - When checking out this repository on another development machine, run - <pre class="highlight plaintext">$ bundle install</pre> - </p> - <p> - When checking out this repository on a deployment machine, run - <pre class="highlight plaintext">$ bundle install --deployment</pre> - </p> - <p> - After changing the <code>Gemfile</code> to reflect a new or update - dependency, run - <pre class="highlight plaintext">$ bundle install</pre> - </p> - <p> - Make sure to check the updated <code>Gemfile.lock</code> into version - control - <pre class="highlight plaintext">$ git add Gemfile.lock</pre> - </p> - <p> - If <code>bundle install</code> reports a conflict, manually update the - specific gems that you changed in the <code>Gemfile</code> - <pre class="highlight plaintext">$ bundle update rails thin</pre> - </p> - <p> - If you want to update all the gems to the latest possible versions that - still match the gems listed in the <code>Gemfile</code>, run - <pre class="highlight plaintext">$ bundle update</pre> - </p> - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_version.html b/v1.2/bundle_version.html deleted file mode 100644 index 566469ebc7..0000000000 --- a/v1.2/bundle_version.html +++ /dev/null @@ -1,64 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle version</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Prints the bundler's version information - </div> - <pre class="highlight plaintext">$ bundle version</pre> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundle_viz.html b/v1.2/bundle_viz.html deleted file mode 100644 index 5ed99e6f95..0000000000 --- a/v1.2/bundle_viz.html +++ /dev/null @@ -1,86 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>bundle viz</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Generates a visual dependency graph - </div> - <pre class="highlight plaintext">$ bundle viz [--file=FILE] [--format=FORMAT] [--requirements] [--version]</pre> - <div class='notes'> - <p> - Options: - </p> - <p> - <code>--file or -f</code>: The name to use for the generated file. see format option - </p> - <p> - <code>--format or -F</code>: This is output format option. Supported format is png, jpg, svg, dot ... - </p> - <p> - <code>--requirements or -r</code>: Set to show the version of each required dependency. - </p> - <p> - <code>--version or -v</code>: Set to show each gem version. - </p> - </div> - <div class='description'> - Viz generates a PNG file of the current Gemfile as a dependency graph. - Viz requires the ruby-graphviz gem (and its dependencies). - The associated gems must also be installed via 'bundle install'. - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/bundler_setup.html b/v1.2/bundler_setup.html deleted file mode 100644 index e5b9489ff2..0000000000 --- a/v1.2/bundler_setup.html +++ /dev/null @@ -1,72 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>Bundler.setup</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Configure the load path so all dependencies in your Gemfile can be required - </div> - <pre class="highlight ruby"><span class="nb">require</span> <span class="s1">'rubygems'</span>
<span class="nb">require</span> <span class="s1">'bundler/setup'</span>
<span class="nb">require</span> <span class="s1">'nokogiri'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Only add gems from specified groups to the load path. If you want the gems - in the default group, make sure to include it - </div> - <pre class="highlight ruby"><span class="nb">require</span> <span class="s1">'rubygems'</span>
<span class="nb">require</span> <span class="s1">'bundler'</span>
<span class="no">Bundler</span><span class="p">.</span><span class="nf">setup</span><span class="p">(</span><span class="ss">:default</span><span class="p">,</span> <span class="ss">:ci</span><span class="p">)</span>
<span class="nb">require</span> <span class="s1">'nokogiri'</span></pre> - <a href="/v1.2/groups.html">Learn More: Groups</a> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/commands.html b/v1.2/commands.html deleted file mode 100644 index 4ff1a4e11a..0000000000 --- a/v1.2/commands.html +++ /dev/null @@ -1,375 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>Command Line Reference</h2> - <div id='command_reference'> - <table cellspacing='0'> - <tr> - <th> - command - </th> - <th> - applicable options - </th> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_check.html">bundle check</a> - </div> - <div class='cli_desc'> - Checks if the dependencies listed in Gemfile are satisfied by currently installed gems - </div> - </td> - <td> - <div class='cli_option'> - <a href="/v1.2/bundle_check.html#gemfile">--gemfile</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_check.html#path">--path</a> - </div> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_clean.html">bundle clean</a> - </div> - <div class='cli_desc'> - Cleans up unused gems in your bundler directory - </div> - </td> - <td> - <div class='cli_option'> - <a href="/v1.2/bundle_clean.html#force">--force</a> - </div> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_config.html">bundle config</a> - </div> - <div class='cli_desc'> - Retrieve or set a configuration value - </div> - </td> - <td> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_console.html">bundle console</a> - </div> - <div class='cli_desc'> - Opens an IRB session with the bundle pre-loaded - </div> - </td> - <td> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_exec.html">bundle exec</a> - </div> - <div class='cli_desc'> - Run the command in context of the bundle - </div> - </td> - <td> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_gem.html">bundle gem</a> - </div> - <div class='cli_desc'> - Creates a skeleton for creating a rubygem - </div> - </td> - <td> - <div class='cli_option'> - <a href="/v1.2/bundle_gem.html#bin">--bin or -b</a> - </div> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_init.html">bundle init</a> - </div> - <div class='cli_desc'> - Generates a Gemfile into the current working directory - </div> - </td> - <td> - <div class='cli_option'> - <a href="/v1.2/bundle_init.html#gemspec">--gemspec</a> - </div> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_install.html">bundle install</a> - </div> - <div class='cli_desc'> - Install the current environment to the system - </div> - </td> - <td> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#binstubs">--binstubs</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#clean">--clean</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#deployment">--deployment</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#frozen">--frozen</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#full-index">--full-index</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#gemfile">--gemfile</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#local">--local</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#no-cache">--no-cache</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#no-prune">--no-prune</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#path">--path</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#quiet">--quiet</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#shebang">--shebang</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#standalone">--standalone</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#system">--system</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_install.html#without">--without</a> - </div> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_open.html">bundle open</a> - </div> - <div class='cli_desc'> - Opens the source directory of the given bundled gem - </div> - </td> - <td> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_outdated.html">bundle outdated</a> - </div> - <div class='cli_desc'> - List installed gems with newer versions available - </div> - </td> - <td> - <div class='cli_option'> - <a href="/v1.2/bundle_outdated.html#local">--local</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_outdated.html#pre">--pre</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_outdated.html#source">--source</a> - </div> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_package.html">bundle package</a> - </div> - <div class='cli_desc'> - Locks and then caches all of the gems into vendor/cache - </div> - </td> - <td> - <div class='cli_option'> - <a href="/v1.2/bundle_package.html#no-prune">--no-prune</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_package.html#all">--all</a> - </div> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_platform.html">bundle platform</a> - </div> - <div class='cli_desc'> - Displays platform compatibility information - </div> - </td> - <td> - <div class='cli_option'> - <a href="/v1.2/bundle_platform.html#ruby">--ruby</a> - </div> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_show.html">bundle show</a> - </div> - <div class='cli_desc'> - Shows all gems that are part of the bundle, or the path to a given gem - </div> - </td> - <td> - <div class='cli_option'> - <a href="/v1.2/bundle_show.html#paths">--paths</a> - </div> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_update.html">bundle update</a> - </div> - <div class='cli_desc'> - Update the current environment - </div> - </td> - <td> - <div class='cli_option'> - <a href="/v1.2/bundle_update.html#local">--local</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_update.html#source">--source</a> - </div> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_version.html">bundle version</a> - </div> - <div class='cli_desc'> - Prints version information - </div> - </td> - <td> - <div class='clear'></div> - </td> - </tr> - <tr> - <td> - <div class='cli_name'> - <a href="/v1.2/bundle_viz.html">bundle viz</a> - </div> - <div class='cli_desc'> - Generates a visual dependency graph - </div> - </td> - <td> - <div class='cli_option'> - <a href="/v1.2/bundle_viz.html#file">--file or -f</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_viz.html#format">--format or -F</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_viz.html#requirements">--requirements or -r</a> - </div> - <div class='cli_option'> - <a href="/v1.2/bundle_viz.html#version">--version or -v</a> - </div> - <div class='clear'></div> - </td> - </tr> - </table> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/deploying.html b/v1.2/deploying.html deleted file mode 100644 index 42cc62d29c..0000000000 --- a/v1.2/deploying.html +++ /dev/null @@ -1,140 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>Deploying bundled applications</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Before deploying an app that uses Bundler, Add your <code>Gemfile</code> - and <code>Gemfile.lock</code> to source control, but ignore the - <code>.bundle</code> folder, which is specific to each machine. - </div> - <pre class="highlight plaintext">$ echo ".bundle\n" >> .gitignore
$ git add Gemfile Gemfile.lock .gitignore
$ git commit -m "Add Bundler support"</pre> - <div class='notes'> - Once you have done that, there are two ways to deploy using Bundler: - manually or automatically. - </div> - </div> - <div class='bullet'> - <div class='description'> - <h3>Manual deployment</h3> - In your deploy script, after updating to the latest - code, install your bundle to the <code>vendor/bundle</code> - directory, ensuring all your dependencies are met. - </div> - <pre class="highlight plaintext">$ bundle install --deployment</pre> - <div class='notes'> - <p> - Start your application servers as usual, and your - application will use your bundled environment - with the exact same gems you use in development. - </p> - <p> - If you have run <code>bundle package</code>, the cached - gems will be used automatically. - </p> - <a href="/v1.2/bundle_package.html">Learn More: Packing</a> - </div> - </div> - <div class='bullet'> - <h3>Automatic deployment with Capistrano</h3> - <div class='description'> - To pull in the Bundler Cap task, just add this to your - <code>deploy.rb</code> file: - </div> - <pre class="highlight ruby"><span class="nb">require</span> <span class="s1">'bundler/capistrano'</span></pre> - <div class='notes'> - That's it! Running <code>cap deploy</code> will now automatically run - <code>bundle install</code> on the remote server with deployment-friendly - options. A list of options that can be changed is available in the help - for the cap task. To see it, run <code>cap -e bundle:install</code>. - </div> - </div> - <div class='bullet'> - <div class='description'> - <h3>Automatic deployment with Vlad</h3> - There is a default Vlad task available. To make it available, add this line - to the Vlad <code>deploy.rb</code>. - </div> - <pre class="highlight ruby"><span class="nb">require</span> <span class="s1">'bundler/vlad'</span></pre> - <div class='notes'> - Once you have done that, the <code>vlad:bundle:install</code> task will be - available for use. Make sure it is run as part of your deploy. For example: - </div> - <pre class="highlight ruby"><span class="n">task</span> <span class="s2">"vlad:deploy"</span> <span class="o">=></span> <span class="sx">%w[
 vlad:update vlad:bundle:install vlad:start_app vlad:cleanup
]</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - <h3>After deploying</h3> - Make sure to use <code>bundle exec</code> to run any executables - from gems in the bundle - </div> - <pre class="highlight plaintext">$ bundle exec rake db:setup</pre> - <div class='notes'> - Alternatively, you can use the <code>--binstubs</code> option on the - install command to generate executable binaries that can be used instead of - <code>bundle exec</code>. - </div> - <a href="./man/bundle-exec.1.html">Learn More: Executables</a> - </div> - <div class='bullet'> - <div class='description'> - <h3>Heroku</h3> - When you deploy to Heroku, Bundler will be run automatically as long as a Gemfile is present. If you check in your Gemfile.lock, Heroku will run <code>`bundle install --deployment`</code>. If you want to exclude certain groups using the <code>--without</code> option, you need to use <code>`heroku config`</code>. - </div> - <pre class="highlight plaintext">$ heroku config:add BUNDLE_WITHOUT="test development" --app app_name</pre> - <a href="http://docs.heroku.com/bundler">Heroku Bundler Documentation</a> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/gemfile.html b/v1.2/gemfile.html deleted file mode 100644 index 27721f9fdc..0000000000 --- a/v1.2/gemfile.html +++ /dev/null @@ -1,147 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>In Depth</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Read the manual for an in-depth discussion of all of the options available in the - <code>Gemfile</code> and how to use them. - </div> - <a href="./man/gemfile.5.html">Gemfile manual</a> - </div> - </div> - <h2>Gemfiles</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Gemfiles require at least one gem source, in the form of the URL for a Rubygems server. - There are shortcuts for the default gem server, so all of these sources are the same. - </div> - <pre class="highlight ruby"><span class="n">source</span> <span class="ss">:rubygems</span>
<span class="n">source</span> <span class="s1">'http://rubygems.org'</span>
<span class="n">source</span> <span class="ss">:rubyforge</span>
<span class="n">source</span> <span class="s1">'http://gems.rubyforge.org'</span>
<span class="n">source</span> <span class="ss">:gemcutter</span>
<span class="n">source</span> <span class="s1">'http://gemcutter.org'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Declare the gems that you need, including version numbers. Specify versions using the same - syntax that Rubygems supports for dependencies. - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'nokogiri'</span>
<span class="n">gem</span> <span class="s1">'rails'</span><span class="p">,</span> <span class="s1">'3.0.0.beta3'</span>
<span class="n">gem</span> <span class="s1">'rack'</span><span class="p">,</span> <span class="s1">'>=1.0'</span>
<span class="n">gem</span> <span class="s1">'thin'</span><span class="p">,</span> <span class="s1">'~>1.1'</span></pre> - <div class='notes'> - Most of the version specifiers, like <code>>= 1.0</code>, are self-explanatory. - The specifier <code>~></code> has a special meaning, best shown by example. - <code>~> 2.0.3</code> is identical to <code>>= 2.0.3</code> and <code>< 2.1</code>. - <code>~> 2.1</code> is identical to <code>>= 2.1</code> and <code>< 3.0</code>. - <code>~> 2.2.beta</code> will match prerelease versions like <code>2.2.beta.12</code>. - </div> - <a href="http://guides.rubygems.org/patterns/#pessimistic_version_constraint">Rubygems version specifiers</a> - </div> - <div class='bullet'> - <div class='description'> - If a gem's main file is different than the gem name, specify how to require it. - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'rspec'</span><span class="p">,</span> <span class="ss">:require</span> <span class="o">=></span> <span class="s1">'spec'</span>
<span class="n">gem</span> <span class="s1">'sqlite3'</span></pre> - <div class='description'> - Specify <code>:require => false</code> to prevent bundler from requiring the gem, but still install it and maintain dependencies. - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'rspec'</span><span class="p">,</span> <span class="ss">:require</span> <span class="o">=></span> <span class="kp">false</span>
<span class="n">gem</span> <span class="s1">'sqlite3'</span></pre> - <div class='notes'> - In order to require gems in your <code>Gemfile</code>, you will need to call - <code>Bundler.require</code> in your application. - </div> - <a href="/v1.2/groups.html">Learn More: Bundler.require</a> - </div> - <div class='bullet'> - <div class='description'> - Git repositories are also valid gem sources, as long as the repo contains one or - more valid gems. Specify what to check out with <code>:tag</code>, - <code>:branch</code>, or <code>:ref</code>. The default is the <code>master</code> branch. - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'nokogiri'</span><span class="p">,</span> <span class="ss">:git</span> <span class="o">=></span> <span class="s1">'https://github.com/tenderlove/nokogiri.git'</span><span class="p">,</span> <span class="ss">:branch</span> <span class="o">=></span> <span class="s1">'1.4'</span>

<span class="n">git</span> <span class="s1">'https://github.com/wycats/thor.git'</span><span class="p">,</span> <span class="ss">:tag</span> <span class="o">=></span> <span class="s1">'v0.13.4'</span>
<span class="n">gem</span> <span class="s1">'thor'</span></pre> - <div class='notes'> - If the git repository does not contain a <code>.gemspec</code> file, bundler - will create a simple one, without any dependencies, executables or C extensions. - This may work for simple gems, but not work for others. If there is no .gemspec, - you probably shouldn't use the gem from git. - </div> - <a href="/v1.2/git.html">Learn more: Git</a> - </div> - <div class='bullet'> - <div class='description'> - If you are actively developing a gem, perhaps checked out from Github, you can use the gem - directly from its directory on your filesystem. - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'nokogiri'</span><span class="p">,</span> <span class="ss">:path</span> <span class="o">=></span> <span class="s1">'~/sw/gems/nokogiri'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Dependencies can be placed into groups, to be ignored at install-time or required all at once. - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'wirble'</span><span class="p">,</span> <span class="ss">:group</span> <span class="o">=></span> <span class="ss">:development</span>
<span class="n">gem</span> <span class="s1">'ruby-debug'</span><span class="p">,</span> <span class="ss">:group</span> <span class="o">=></span> <span class="o">[</span><span class="ss">:development</span><span class="p">,</span> <span class="ss">:test</span><span class="o">]</span>

<span class="n">group</span> <span class="ss">:test</span> <span class="k">do</span>
 <span class="n">gem</span> <span class="s1">'rspec'</span>
<span class="k">end</span></pre> - <a href="/v1.2/groups.html">Learn more: Groups</a> - </div> - <div class='bullet'> - <div class='description'> - You can now specify the version of Ruby in the <code>Gemfile</code> like the following: - </div> - <pre class="highlight ruby"><span class="n">ruby</span> <span class="s1">'1.9.3'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - What this means is that this app has a dependency to a Ruby VM that is ABI compatible with 1.9.3. If the version check does not match, Bundler will raise an exception. This will ensure the running code matches. You can be more specific with the <code>:engine</code> and <code>:engine_version</code> options. - </div> - <pre class="highlight ruby"><span class="n">ruby</span> <span class="s1">'1.9.3'</span><span class="p">,</span> <span class="ss">:engine</span> <span class="o">=></span> <span class="s1">'jruby'</span><span class="p">,</span> <span class="ss">:engine_version</span> <span class="o">=></span> <span class="s1">'1.6.7'</span></pre> - <a href="/v1.2/gemfile_ruby.html">Learn More: Ruby Directive</a> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/gemfile_ruby.html b/v1.2/gemfile_ruby.html deleted file mode 100644 index 144f8c3109..0000000000 --- a/v1.2/gemfile_ruby.html +++ /dev/null @@ -1,93 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>Specifying a Ruby Version</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Like gems, developers can setup a dependency on Ruby. This makes your app fail faster in case you depend on specific features in a Ruby VM. This way, the Ruby VM on your deployment server will match your local one. You can do this by using the <code>ruby</code> directive in the <code>Gemfile</code>: - </div> - <pre class="highlight ruby"><span class="n">ruby</span> <span class="s1">'RUBY_VERSION'</span><span class="p">,</span> <span class="ss">:engine</span> <span class="o">=></span> <span class="s1">'ENGINE'</span><span class="p">,</span> <span class="ss">:engine_version</span> <span class="o">=></span> <span class="s1">'ENGINE_VERSION'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - If you wanted to use JRuby 1.6.7 using Ruby 1.9.3, you would simply do the following: - </div> - <pre class="highlight ruby"><span class="n">ruby</span> <span class="s1">'1.9.3'</span><span class="p">,</span> <span class="ss">:engine</span> <span class="o">=></span> <span class="s1">'jruby'</span><span class="p">,</span> <span class="ss">:engine_version</span> <span class="o">=></span> <span class="err">'</span><span class="mi">1</span><span class="o">.</span><span class="mi">6</span><span class="o">.</span><span class="mi">7</span><span class="s2">"

</span></pre> - </div> - <div class='bullet'> - <div class='description'> - Bundler will make checks against the current running Ruby VM to make sure it matches what is specified in the <code>Gemfile</code>. If things don't match, Bundler will raise an Exception explaining what doesn't match. - </div> - <pre class="highlight plaintext">Your Ruby version is 1.8.7, but your Gemfile specified 1.9.3
</pre> - </div> - <div class='bullet'> - <div class='description'> - Both <code>:engine</code> and <code>:engine_version</code> are optional. When these options are omitted, this means the app is compatible with a particular Ruby ABI but the engine is irrelevant. When <code>:engine</code> is used, <code>:engine_version</code> must also be specified. - </div> - </div> - <div class='bullet'> - <div class='description'> - Using the <code>platform</code> command with the <code>--ruby</code> flag, you can see what <code>ruby</code> directive is specified in the <code>Gemfile</code>. - </div> - <pre class="highlight plaintext">ruby 1.9.3 (jruby 1.6.7)</pre> - <a href="/v1.2/bundle_platform.html">Learn More: bundle platform</a> - </div> - <div class='bullet'> - <div class='description'> - The <code>ruby</code> directive explicitly leaves out the ability to specify a patch level. Ruby patches often include important bug and security fixes and are extremely compatible. - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/git.html b/v1.2/git.html deleted file mode 100644 index 58763fa883..0000000000 --- a/v1.2/git.html +++ /dev/null @@ -1,203 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>Gems from git repositories</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Bundler adds the ability to use gems directly from git repositories. Setting - them up is as easy as adding a gem to your Gemfile. Using the very latest - version of a gem (or even a fork) is just as easy as using an official - release. - </div> - <div class='description'> - Because Rubygems lacks the ability to handle gems from git, any gems - installed from a git repository will not show up in <code>gem list</code>. - They will, however, be available after running <code>Bundler.setup</code>. - </div> - </div> - <div class='bullet'> - <div class='description'> - Specify that a gem should come from a git - repository with a .gemspec at its root - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'nokogiri'</span><span class="p">,</span> <span class="ss">:git</span> <span class="o">=></span> <span class="s1">'https://github.com/tenderlove/nokogiri.git'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - If there is no .gemspec at the root of - a git repository, you must specify a version - that bundler should use when resolving - dependencies - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'deep_merge'</span><span class="p">,</span> <span class="s1">'1.0'</span><span class="p">,</span> <span class="ss">:git</span> <span class="o">=></span> <span class="s1">'https://github.com/peritor/deep_merge.git'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Specify that a git repository containing - multiple .gemspec files should be treated - as a gem source - </div> - <pre class="highlight ruby"><span class="n">git</span> <span class="s1">'https://github.com/rails/rails.git'</span> <span class="k">do</span>
 <span class="n">gem</span> <span class="s1">'railties'</span>
 <span class="n">gem</span> <span class="s1">'action_pack'</span>
 <span class="n">gem</span> <span class="s1">'active_model'</span>
<span class="k">end</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Specify that a git repository should use - a particular ref, branch, or tag - </div> - <pre class="highlight ruby"><span class="ss">:git</span> <span class="o">=></span> <span class="s1">'https://github.com/rails/rails.git'</span><span class="p">,</span> <span class="ss">:ref</span> <span class="o">=></span> <span class="s1">'4aded'</span>
<span class="ss">:git</span> <span class="o">=></span> <span class="s1">'https://github.com/rails/rails.git'</span><span class="p">,</span> <span class="ss">:branch</span> <span class="o">=></span> <span class="s1">'2-3-stable'</span>
<span class="ss">:git</span> <span class="o">=></span> <span class="s1">'https://github.com/rails/rails.git'</span><span class="p">,</span> <span class="ss">:tag</span> <span class="o">=></span> <span class="s1">'v2.3.5'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Specifying a ref, branch, or tag for a - git repository specified inline works - exactly the same way - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'nokogiri'</span><span class="p">,</span> <span class="ss">:git</span> <span class="o">=></span> <span class="s1">'https://github.com/tenderlove/nokogiri.git'</span><span class="p">,</span> <span class="ss">:ref</span> <span class="o">=></span> <span class="s1">'0eec4'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Bundler can use HTTP(S), SSH, or git - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'nokogiri'</span><span class="p">,</span> <span class="ss">:git</span> <span class="o">=></span> <span class="s1">'https://github.com/tenderlove/nokogiri.git'</span>
<span class="n">gem</span> <span class="s1">'nokogiri'</span><span class="p">,</span> <span class="ss">:git</span> <span class="o">=></span> <span class="s1">'git@github.com:tenderlove/nokogiri.git'</span>
<span class="n">gem</span> <span class="s1">'nokogiri'</span><span class="p">,</span> <span class="ss">:git</span> <span class="o">=></span> <span class="s1">'git://github.com/tenderlove/nokogiri.git'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - If you are getting your gems from a public GitHub repository, - you can use the shorthand - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'nokogiri'</span><span class="p">,</span> <span class="ss">:github</span> <span class="o">=></span> <span class="s1">'tenderlove/nokogiri'</span></pre> - <div class='description'> - If the repository name is the same as the GitHub account hosting it, - you can omit it - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'rails'</span><span class="p">,</span> <span class="ss">:github</span> <span class="o">=></span> <span class="s1">'rails'</span></pre> - <div class='description'> - <b>NB:</b> This shorthand is insecure in versions of Bundler prior to 2.0! Use HTTPS instead - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'rails'</span><span class="p">,</span> <span class="ss">:git</span> <span class="o">=></span> <span class="s1">'https://github.com/rails/rails'</span></pre> - <div class='description'> - Alternatively, you can specify a full commit hash - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'rails'</span><span class="p">,</span> <span class="ss">:github</span> <span class="o">=></span> <span class="s1">'rails'</span><span class="p">,</span> <span class="ss">:ref</span> <span class="o">=></span> <span class="s1">'a9752dcfd15bcddfe7b6f7126f3a6e0ba5927c56'</span>
</pre> - </div> - </div> - <h2>Security</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - <code>http://</code> and <code>git://</code> URLs are insecure, and should - be avoided if at all possible. These protocols are unauthenticated, so a - man-in-the-middle attacker can tamper with the code and compromise your system. - Note that the <code>:github</code> shortcut translates to a <code>git://</code> - URL in pre-2.0 versions. - </div> - </div> - </div> - <h2 id='local'>Local Git Repos</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - 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: - </div> - <pre class="highlight plaintext">bundle config local.GEM_NAME /path/to/local/git/repository
</pre> - </div> - <div class='bullet'> - <div class='description'> - For example, in order to use a local Rack repository, a developer could call: - </div> - <pre class="highlight plaintext">bundle config local.rack ~/Work/git/rack</pre> - <div class='description'> - and setup the git repo pointing to a branch: - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'rack'</span><span class="p">,</span> <span class="ss">:github</span> <span class="o">=></span> <span class="s1">'rack/rack'</span><span class="p">,</span> <span class="ss">:branch</span> <span class="o">=></span> <span class="s1">'master'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - <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> - </div> - </div> - <div class='bullet'> - <div class='description'> - <p>If you do not want bundler to make these branch checks, you can override it by setting this option:</p> - </div> - <pre class="highlight plaintext">bundle config disable_local_branch_check true</pre> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/groups.html b/v1.2/groups.html deleted file mode 100644 index 7c63f13915..0000000000 --- a/v1.2/groups.html +++ /dev/null @@ -1,99 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>Using Groups</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Grouping your dependencies allows you - to perform operations on the entire - group. - </div> - <pre class="highlight ruby"><span class="c1"># These gems are in the :default group</span>
<span class="n">gem</span> <span class="s1">'nokogiri'</span>
<span class="n">gem</span> <span class="s1">'sinatra'</span>

<span class="n">gem</span> <span class="s1">'wirble'</span><span class="p">,</span> <span class="ss">:group</span> <span class="o">=></span> <span class="ss">:development</span>

<span class="n">group</span> <span class="ss">:test</span> <span class="k">do</span>
 <span class="n">gem</span> <span class="s1">'faker'</span>
 <span class="n">gem</span> <span class="s1">'rspec'</span>
<span class="k">end</span>

<span class="n">group</span> <span class="ss">:test</span><span class="p">,</span> <span class="ss">:development</span> <span class="k">do</span>
 <span class="n">gem</span> <span class="s1">'capybara'</span>
 <span class="n">gem</span> <span class="s1">'rspec-rails'</span>
<span class="k">end</span>

<span class="n">gem</span> <span class="s1">'cucumber'</span><span class="p">,</span> <span class="ss">:group</span> <span class="o">=></span> <span class="o">[</span><span class="ss">:cucumber</span><span class="p">,</span> <span class="ss">:test</span><span class="o">]</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Install all gems, except those in the - listed groups. Gems in at least one - non-excluded group will still be installed. - </div> - <pre class="highlight plaintext">$ bundle install --without test development
</pre> - </div> - <div class='bullet'> - <div class='description'> - Require the gems in particular groups, - noting that gems outside of a named group - are in the :default group - </div> - <pre class="highlight ruby"><span class="no">Bundler</span><span class="p">.</span><span class="nf">require</span><span class="p">(</span><span class="ss">:default</span><span class="p">,</span> <span class="ss">:development</span><span class="p">)</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Require the default gems, plus the gems - in a group named the same as the current - Rails environment - </div> - <pre class="highlight ruby"><span class="no">Bundler</span><span class="p">.</span><span class="nf">require</span><span class="p">(</span><span class="ss">:default</span><span class="p">,</span> <span class="no">Rails</span><span class="p">.</span><span class="nf">env</span><span class="p">)</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Restrict the groups of gems that you - want to add to the load path. Only gems - in these groups will be require'able - </div> - <pre class="highlight ruby"><span class="nb">require</span> <span class="s1">'rubygems'</span>
<span class="nb">require</span> <span class="s1">'bundler'</span>
<span class="no">Bundler</span><span class="p">.</span><span class="nf">setup</span><span class="p">(</span><span class="ss">:default</span><span class="p">,</span> <span class="ss">:ci</span><span class="p">)</span>
<span class="nb">require</span> <span class="s1">'nokogiri'</span></pre> - <a href="/v1.2/bundler_setup.html">Learn More: Bundler.setup</a> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/index.html b/v1.2/index.html deleted file mode 100644 index 45c694460c..0000000000 --- a/v1.2/index.html +++ /dev/null @@ -1,170 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>What is Bundler?</h2> - <div id='intro'> - Bundler maintains a consistent environment for ruby applications. It tracks an application's code and the rubygems it needs to run, so that an application will always have the exact gems (and versions) that it needs to run. - </div> - <h2>Would you like to</h2> - <div class='buttons'> - <a href="#getting-started">Get started</a> - <a href="https://github.com/bundler/bundler/blob/master/ISSUES.md">Report a bug</a> - <a href="/v1.2/whats_new.html">See what's new</a> - <a href="#use-bundler">Read documentation</a> - </div> - <h2 id='getting-started'> - Getting Started - </h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Getting started with bundler is easy! Open a terminal window and type the following: - </div> - <pre class="highlight plaintext">$ gem install bundler
</pre> - </div> - <div class='bullet'> - <div class='description'> - Specify your dependencies in a Gemfile in your project's root: - </div> - <pre class="highlight ruby"><span class="n">source</span> <span class="s2">"https://rubygems.org"</span>
<span class="n">gem</span> <span class="s2">"nokogiri"</span>
<span class="n">gem</span> <span class="s2">"rack"</span><span class="p">,</span> <span class="s2">"~>1.1"</span>
<span class="n">gem</span> <span class="s2">"rspec"</span><span class="p">,</span> <span class="ss">:require</span> <span class="o">=></span> <span class="s2">"spec"</span></pre> - <a href="/v1.2/gemfile.html">Learn More: Gemfiles</a> - </div> - <div class='bullet'> - <div class='description'> - Install all of the required gems from your specified sources: - </div> - <pre class="highlight plaintext">$ bundle install
$ git add Gemfile Gemfile.lock</pre> - <a href="/v1.2/bundle_install.html">Learn More: bundle install</a> - <div class='notes'> - The second command adds the Gemfile and Gemfile.lock to your repository. This ensures - that other developers on your app, as well as your deployment environment, will all use - the same third-party code that you are using now. - </div> - </div> - <div class='bullet'> - <div class='description'> - Inside your app, load up the bundled environment: - </div> - <pre class="highlight ruby"><span class="nb">require</span> <span class="s2">"rubygems"</span>
<span class="nb">require</span> <span class="s2">"bundler/setup"</span>

<span class="c1"># require your gems as usual</span>
<span class="nb">require</span> <span class="s2">"nokogiri"</span></pre> - <a href="/v1.2/bundler_setup.html">Learn More: Bundler.setup</a> - </div> - <div class='bullet'> - <div class='description'> - Run an executable that comes with a gem in your bundle: - </div> - <pre class="highlight plaintext">$ bundle exec rspec spec/models</pre> - <div class='notes'> - <p> - In some cases, running executables without <code>bundle exec</code> - may work, if the executable happens to be installed in your system - and does not pull in any gems that conflict with your bundle. - </p> - <p> - However, this is unreliable and is the source of considerable pain. - Even if it looks like it works, it may not work in the future or - on another machine. - </p> - </div> - <div class='description'> - Finally, if you want a way to get a shortcut to gems in your bundle: - </div> - <pre class="highlight plaintext">$ bundle install --binstubs
$ bin/rspec spec/models</pre> - <div class='notes'> - The executables installed into <code>bin</code> are scoped to the - bundle, and will always work. - </div> - <a href="/v1.2/man/bundle-exec.1.html">Learn More: Executables</a> - </div> - </div> - <h2 id='use-bundler'>Use Bundler with</h2> - <div class='buttons'> - <a href="/v1.2/rails3.html">Rails 3</a> - <a href="/v1.2/rails23.html">Rails 2.3</a> - <a href="/v1.2/sinatra.html">Sinatra</a> - <a href="/v1.2/rubygems.html">Rubygems</a> - <a href="/v1.2/rubymotion.html">RubyMotion</a> - </div> - <h2 id='learn-about'>Learn about</h2> - <div class='buttons'> - <a href="/v1.2/gemfile.html">Gemfile</a> - <a href="/v1.2/bundle_install.html">Installing</a> - <a href="/v1.2/man/bundle-update.1.html">Updating</a> - <a href="/v1.2/deploying.html">Deploying</a> - </div> - <div class='buttons'> - <a href="/v1.2/git.html">Gems from git</a> - <a href="/v1.2/commands.html">Other commands</a> - <a href="/v1.2/rationale.html">Why Bundler exists</a> - <a href="/v1.2/man/bundle.1.html">The man pages</a> - </div> - <h2 id='get-involved'>Get involved</h2> - <p>Bundler has a lot of contributors and users, and they all talk to each other quite a bit. If you have questions, try the IRC channel or mailing list. If you're interested in contributing to the project (no programming skills needed), read the contributing guide. If you have sponsorship or security questions, email us directly.</p> - <div class='buttons'> - <a href="https://github.com/bundler/bundler/blob/master/DEVELOPMENT.md">Contributing</a> - <a href="http://groups.google.com/group/ruby-bundler">Mailing list</a> - <a href="irc://irc.freenode.net/#bundler">IRC channel</a> - <a href="mailto:andre.arko+terence.lee@gmail.com">Email core team</a> - </div> - <div class='shirts'> - <div class='content'> - <img src="/images/bundler-shirt.png" /> - <p> - Want to show the world you support Bundler? - <br> - Buy Bundler shirts and stickers at - <a href="http://www.devswag.com/collections/bundler">DevSwag</a> - </p> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/man/bundle-config.1.html b/v1.2/man/bundle-config.1.html deleted file mode 100644 index 8cb39492fc..0000000000 --- a/v1.2/man/bundle-config.1.html +++ /dev/null @@ -1,215 +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> - </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>.</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.</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> -</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> - - - <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/v1.2/man/bundle-exec.1.html b/v1.2/man/bundle-exec.1.html deleted file mode 100644 index 8e2d09e8b1..0000000000 --- a/v1.2/man/bundle-exec.1.html +++ /dev/null @@ -1,202 +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="#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> <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="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>When shelling out (using the <code>system</code> or backticks methods, -for example), Bundler's environment changes will propogate to -the subshell environment. If you desire to shell out without -Bundler's environment changes, simply employ the <code>with_clean_env</code> -method. It will restore all environment variables to what they -were before Bundler was activated. For example:</p> - -<pre><code>Bundler.with_clean_env do - `brew install wget` -end -</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/v1.2/man/bundle-install.1.html b/v1.2/man/bundle-install.1.html deleted file mode 100644 index dc5e986de7..0000000000 --- a/v1.2/man/bundle-install.1.html +++ /dev/null @@ -1,409 +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> - </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...]]] - [--quiet] - [--no-cache]</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 the gem home, which is the location that <code>gem install</code> installs -gems to. 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>--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> -</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 "http://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 "http://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 "http://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 satify 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> - - - <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/v1.2/man/bundle-package.1.html b/v1.2/man/bundle-package.1.html deleted file mode 100644 index 7a122559f1..0000000000 --- a/v1.2/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 "http://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/v1.2/man/bundle-platform.1.html b/v1.2/man/bundle-platform.1.html deleted file mode 100644 index bf7819e32d..0000000000 --- a/v1.2/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 "http://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/v1.2/man/bundle-update.1.html b/v1.2/man/bundle-update.1.html deleted file mode 100644 index 3e5ccb7fb2..0000000000 --- a/v1.2/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 "http://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 http://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 "http://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 http://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/v1.2/man/bundle.1.html b/v1.2/man/bundle.1.html deleted file mode 100644 index bc22b04a80..0000000000 --- a/v1.2/man/bundle.1.html +++ /dev/null @@ -1,150 +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://gembundler.com">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> -</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><code>bundle platform(1)</code></dt><dd><p>Displays platform compatibility information</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/v1.2/man/gemfile.5.html b/v1.2/man/gemfile.5.html deleted file mode 100644 index 0ac4538fe0..0000000000 --- a/v1.2/man/gemfile.5.html +++ /dev/null @@ -1,422 +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 "http://rubygems.org" -source "http://gems.github.com" -</code></pre> - -<p>Each of these _source_s <code>MUST</code> be a valid Rubygems repository.</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> - -<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>false</code> to -prevent any file from being autorequired.</p> - -<pre><code>gem "redis", :require => ["redis/connection/hiredis", "redis"] -gem "webmock", :require => false -</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" -</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://gembundler.com/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>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>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 '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> -</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. It <code>MUST NOT</code> have any dependencies, other than on the files in -the git repository itself and any built-in functionality of Ruby or Rubygems.</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> - -<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> diff --git a/v1.2/rails23.html b/v1.2/rails23.html deleted file mode 100644 index 180f22d4f7..0000000000 --- a/v1.2/rails23.html +++ /dev/null @@ -1,107 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <div id='intro'> - Rails 2.3 comes with its own gem handling. We're going to - override that and replace it with support for Bundler. - <div class='notes'> - <b>NB:</b> This <i>may</i> work with Rails versions lower than 2.3. - The Bundler team has not tested those versions, and will not provide - support for anyone on Rails older than 2.3, but feel free to try it. :) - </div> - </div> - <h2>Using Bundler with Rails 2.3</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - If you don't have a Rails 2.3 app yet, generate one - </div> - <pre class="highlight plaintext">$ rails myapp
$ cd myapp
</pre> - </div> - <div class='bullet'> - <div class='description'> - Insert the following code at the bottom of config/boot.rb, - right above the line `Rails.boot!` - </div> - <pre class="highlight ruby"><span class="k">class</span> <span class="nc">Rails</span><span class="o">::</span><span class="no">Boot</span>
 <span class="k">def</span> <span class="nf">run</span>
 <span class="n">load_initializer</span>

 <span class="no">Rails</span><span class="o">::</span><span class="no">Initializer</span><span class="p">.</span><span class="nf">class_eval</span> <span class="k">do</span>
 <span class="k">def</span> <span class="nf">load_gems</span>
 <span class="vi">@bundler_loaded</span> <span class="o">||=</span> <span class="no">Bundler</span><span class="p">.</span><span class="nf">require</span> <span class="ss">:default</span><span class="p">,</span> <span class="no">Rails</span><span class="p">.</span><span class="nf">env</span>
 <span class="k">end</span>
 <span class="k">end</span>

 <span class="no">Rails</span><span class="o">::</span><span class="no">Initializer</span><span class="p">.</span><span class="nf">run</span><span class="p">(</span><span class="ss">:set_load_path</span><span class="p">)</span>
 <span class="k">end</span>
<span class="k">end</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Create a new file, <code>config/preinitializer.rb</code>, - and insert the following. That is <code>config</code> <strong>NOT</strong> - <code>config/initializers</code>. - </div> - <pre class="highlight ruby"><span class="k">begin</span>
 <span class="nb">require</span> <span class="s1">'rubygems'</span>
 <span class="nb">require</span> <span class="s1">'bundler'</span>
<span class="k">rescue</span> <span class="no">LoadError</span>
 <span class="k">raise</span> <span class="s2">"Could not load the bundler gem. Install it with `gem install bundler`."</span>
<span class="k">end</span>

<span class="k">if</span> <span class="no">Gem</span><span class="o">::</span><span class="no">Version</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="no">Bundler</span><span class="o">::</span><span class="no">VERSION</span><span class="p">)</span> <span class="o"><=</span> <span class="no">Gem</span><span class="o">::</span><span class="no">Version</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="s2">"0.9.24"</span><span class="p">)</span>
 <span class="k">raise</span> <span class="no">RuntimeError</span><span class="p">,</span> <span class="s2">"Your bundler version is too old for Rails 2.3.</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span>
 <span class="s2">"Run `gem install bundler` to upgrade."</span>
<span class="k">end</span>

<span class="k">begin</span>
 <span class="c1"># Set up load paths for all bundled gems</span>
 <span class="no">ENV</span><span class="o">[</span><span class="s2">"BUNDLE_GEMFILE"</span><span class="o">]</span> <span class="o">=</span> <span class="no">File</span><span class="p">.</span><span class="nf">expand_path</span><span class="p">(</span><span class="s2">"../../Gemfile"</span><span class="p">,</span> <span class="kp">__FILE__</span><span class="p">)</span>
 <span class="no">Bundler</span><span class="p">.</span><span class="nf">setup</span>
<span class="k">rescue</span> <span class="no">Bundler</span><span class="o">::</span><span class="no">GemNotFound</span>
 <span class="k">raise</span> <span class="no">RuntimeError</span><span class="p">,</span> <span class="s2">"Bundler couldn't find some gems.</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span>
 <span class="s2">"Did you run `bundle install`?"</span>
<span class="k">end</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Get all config.gem declarations from your application, and place - them into the Gemfile. If you have declarations in development.rb, - for instance, place them in a named group. Make sure to include - Rails itself and at least one source - </div> - <pre class="highlight ruby"><span class="n">source</span> <span class="ss">:gemcutter</span>
<span class="n">gem</span> <span class="s1">'rails'</span><span class="p">,</span> <span class="s1">'~> 2.3.5'</span>
<span class="n">gem</span> <span class="s1">'sqlite3-ruby'</span><span class="p">,</span> <span class="ss">:require</span> <span class="o">=></span> <span class="s1">'sqlite3'</span>

<span class="c1"># bundler requires these gems in all environments</span>
<span class="c1"># gem 'nokogiri', '1.4.2'</span>
<span class="c1"># gem 'geokit'</span>

<span class="n">group</span> <span class="ss">:development</span> <span class="k">do</span>
 <span class="c1"># bundler requires these gems in development</span>
 <span class="c1"># gem 'rails-footnotes'</span>
<span class="k">end</span>

<span class="n">group</span> <span class="ss">:test</span> <span class="k">do</span>
 <span class="c1"># bundler requires these gems while running tests</span>
 <span class="c1"># gem 'rspec'</span>
 <span class="c1"># gem 'faker'</span>
<span class="k">end</span></pre> - <a href="/v1.2/groups.html">Learn More: Groups</a> - </div> - <div class='bullet'> - <div class='description'> - Once you have everything set up, you can use script/console, - script/server, and other Rake tasks as usual. From this point - on, you can follow the instructions in the Rails 3 guide - </div> - <pre class="highlight plaintext">$ rake db:migrate</pre> - <a href="/v1.2/rails3.html#shared_with_23">Learn More: Rails 3</a> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/rails3.html b/v1.2/rails3.html deleted file mode 100644 index 3530c8e31e..0000000000 --- a/v1.2/rails3.html +++ /dev/null @@ -1,125 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <div id='intro'> - Rails 3 comes with baked in support with bundler. - </div> - <h2>Using Bundler with Rails 3</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Install Rails as you normally would. Use sudo - if you would normally use sudo to install gems. - </div> - <div class='how'> - <pre class="highlight plaintext">$ gem install rails</pre> - <div class='notes'> - We recommend using rvm for dependable Ruby - installations, especially if you are switching - between different versions of Ruby - </div> - </div> - </div> - <div class='bullet'> - <div class='description'> - Generate a Rails app as usual - </div> - <pre class="highlight plaintext">$ rails new myapp
$ cd myapp
</pre> - </div> - <div class='bullet'> - <div class='description'> - Run the server. Bundler is transparently managing - your dependencies! - </div> - <pre class="highlight plaintext">$ rails server
</pre> - </div> - <div class='bullet'> - <div class='description'> - Add new dependencies to your Gemfile as you - need them. - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'nokogiri'</span>
<span class="n">gem</span> <span class="s1">'geokit'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - If you want a dependency to be loaded only in - a certain Rails environment, place it in a group - named after that Rails environment - </div> - <pre class="highlight ruby"><span class="n">group</span> <span class="ss">:test</span> <span class="k">do</span>
 <span class="n">gem</span> <span class="s1">'rspec'</span>
 <span class="n">gem</span> <span class="s1">'faker'</span>
<span class="k">end</span>
</pre> - </div> - <div class='bullet' id='shared_with_23'> - <div class='description'> - You can place a dependency in multiple groups - at once as well - </div> - <pre class="highlight ruby"><span class="n">group</span> <span class="ss">:development</span><span class="p">,</span> <span class="ss">:test</span> <span class="k">do</span>
 <span class="n">gem</span> <span class="s1">'wirble'</span>
 <span class="n">gem</span> <span class="s1">'ruby-debug'</span>
<span class="k">end</span></pre> - <a href="/v1.2/groups.html">Learn More: Groups</a> - </div> - <div class='bullet'> - <div class='description'> - After adding a dependency, if it is not yet - installed, install it - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle install</pre> - <div class='notes'> - This will update all dependencies in your - Gemfile to the latest versions that do not - conflict with other dependencies - </div> - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/rationale.html b/v1.2/rationale.html deleted file mode 100644 index 5345155f6b..0000000000 --- a/v1.2/rationale.html +++ /dev/null @@ -1,654 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <div id='intro'> - If you just want to know our recommended workflow, and don't care about the rationale, feel - free to jump to the summary below. - </div> - <br> - <div id='standalone'> - <h2 id='bundlers-purpose-and-rationale'> - Bundler's Purpose and Rationale - </h2> - <p> - We designed bundler to make it easy to share your code across a number of development, - staging and production machines. Of course, you know how to share your own application - or gem: stick it on GitHub and clone it where you need it. Bundler makes it easy to - make sure that your application has the dependencies it needs to start up and run without - errors. - </p> - <p> - First, you declare these dependencies in a file at the root of your application, called - <code>Gemfile</code>. It looks something like this: - </p> - <pre class="highlight ruby"><span class="n">source</span> <span class="s1">'http://rubygems.org'</span>

<span class="n">gem</span> <span class="s1">'rails'</span><span class="p">,</span> <span class="s1">'3.0.0.rc'</span>
<span class="n">gem</span> <span class="s1">'rack-cache'</span>
<span class="n">gem</span> <span class="s1">'nokogiri'</span><span class="p">,</span> <span class="s1">'~> 1.4.2'</span>
</pre> - <p> - This <code>Gemfile</code> says a few things. First, it says that bundler should look for gems - declared in the <code>Gemfile</code> at <code>http://rubygems.org</code>. You can declare - multiple Rubygems sources, and bundler will look for gems in the order you declared the - sources. - </p> - <p> - Next, you declare a few dependencies: - </p> - <ul> - <li>on version <code>3.0.0.rc</code> of <code>rails</code></li> - <li>on any version of <code>rack-cache</code></li> - <li>on a version of <code>nokogiri</code> that is <code>>= 1.4.2</code> but <code>< 1.5.0</code></li> - </ul> - <p> - After declaring your first set of dependencies, you tell bundler to go get them: - </p> - <pre class="highlight plaintext">$ bundle install # <code>bundle</code> is a shortcut for <code>bundle install</code>
</pre> - <p> - Bundler will connect to <code>rubygems.org</code> (and any other sources that you declared), - and find a list of all of the required gems that meet the requirements you specified. Because - all of the gems in your <code>Gemfile</code> have dependencies of their own (and some of - those have their own dependencies), running <code>bundle install</code> on the - <code>Gemfile</code> above will install quite a few gems. - </p> - <pre class="highlight plaintext">$ bundle install
Fetching source index for http://gemcutter.org/
Using rake (0.8.7)
Using abstract (1.0.0)
Installing activesupport (3.0.0.rc)
Using builder (2.1.2)
Using i18n (0.4.1)
Installing activemodel (3.0.0.rc)
Using erubis (2.6.6)
Using rack (1.2.1)
Installing rack-mount (0.6.9)
Using rack-test (0.5.4)
Using tzinfo (0.3.22)
Installing actionpack (3.0.0.rc)
Using mime-types (1.16)
Using polyglot (0.3.1)
Using treetop (1.4.8)
Using mail (2.2.5)
Installing actionmailer (3.0.0.rc)
Using arel (0.4.0)
Installing activerecord (3.0.0.rc)
Installing activeresource (3.0.0.rc)
Using bundler (1.0.0.rc.3)
Installing nokogiri (1.4.3.1) with native extensions
Installing rack-cache (0.5.2)
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.
</pre> - <p> - If any of the needed gems are already installed, Bundler will use them. After installing - any needed gems to your system, bundler writes a snapshot of all of the gems and - versions that it installed to <code>Gemfile.lock</code>. - </p> - <h2 id='setting-up-your-application-to-use-bundler'> - Setting Up Your Application to Use Bundler - </h2> - <p> - Bundler makes sure that Ruby can find all of the gems in the <code>Gemfile</code> - (and all of their dependencies). If your app is a Rails 3 app, your default application - already has the code necessary to invoke bundler. If it is a Rails 2.3 app, please see - <a href="./rails23.html">Setting up Bundler in Rails 2.3</a>. - </p> - <p> - For another kind of application (such as a Sinatra application), you will need to set up - bundler before trying to require any gems. At the top of the first file that your - application loads (for Sinatra, the file that calls <code>require 'sinatra'</code>), put - the following code: - </p> - <pre class="highlight ruby"><span class="nb">require</span> <span class="s1">'rubygems'</span>
<span class="nb">require</span> <span class="s1">'bundler/setup'</span>
</pre> - <p> - This will automatically discover your <code>Gemfile</code>, and make all of the gems in - your <code>Gemfile</code> available to Ruby (in technical terms, it puts the gems "on the - load path"). You can think of it as an adding some extra powers to <code>require - 'rubygems'</code>. - </p> - <p> - Now that your code is available to Ruby, you can require the gems that you need. For - instance, you can <code>require 'sinatra'</code>. If you have a lot of dependencies, you - might want to say "require all of the gems in my <code>Gemfile</code>". To do this, put - the following code immediately following <code>require 'bundler/setup'</code>: - </p> - <pre class="highlight ruby"><span class="no">Bundler</span><span class="p">.</span><span class="nf">require</span><span class="p">(</span><span class="ss">:default</span><span class="p">)</span>
</pre> - For our example Gemfile, this line is exactly equivalent to: - <pre class="highlight ruby"><span class="nb">require</span> <span class="s1">'rails'</span>
<span class="nb">require</span> <span class="s1">'rack-cache'</span>
<span class="nb">require</span> <span class="s1">'nokogiri'</span>
</pre> - <p> - Astute readers will notice that the correct way to require the <code>rack-cache</code> - gem is <code>require 'rack/cache'</code>, not <code>require 'rack-cache'</code>. To tell - bundler to use <code>require 'rack/cache'</code>, update your Gemfile: - </p> - <pre class="highlight ruby"><span class="n">source</span> <span class="s1">'http://rubygems.org'</span>

<span class="n">gem</span> <span class="s1">'rails'</span><span class="p">,</span> <span class="s1">'3.0.0.rc'</span>
<span class="n">gem</span> <span class="s1">'rack-cache'</span><span class="p">,</span> <span class="ss">:require</span> <span class="o">=></span> <span class="s1">'rack/cache'</span>
<span class="n">gem</span> <span class="s1">'nokogiri'</span><span class="p">,</span> <span class="s1">'~> 1.4.2'</span>
</pre> - <p> - For such a small <code>Gemfile</code>, we'd advise you to skip - <code>Bundler.require</code> and just require the gems by hand (especially given the - need to put in a <code>:require</code> directive in the <code>Gemfile</code>). For much - larger <code>Gemfile</code>s, using <code>Bundler.require</code> allows you to skip - repeating a large stack of requirements. - </p> - <h2 id='grouping-your-dependencies'> - Grouping Your Dependencies - </h2> - <p> - You'll sometimes have groups of gems that only make sense in particular environments. - For instance, you might develop your app (at an early stage) using SQLite, but deploy it - using <code>mysql2</code> or <code>pg</code>. In this example, you might not have MySQL - or Postgres installed on your development machine, and want bundler to skip it. - </p> - <p> - To do this, you can group your dependencies: - </p> - <pre class="highlight ruby"><span class="n">source</span> <span class="s1">'http://rubygems.org'</span>

<span class="n">gem</span> <span class="s1">'rails'</span><span class="p">,</span> <span class="s1">'3.2.2'</span>
<span class="n">gem</span> <span class="s1">'rack-cache'</span><span class="p">,</span> <span class="ss">:require</span> <span class="o">=></span> <span class="s1">'rack/cache'</span>
<span class="n">gem</span> <span class="s1">'nokogiri'</span><span class="p">,</span> <span class="s1">'~> 1.4.2'</span>

<span class="n">group</span> <span class="ss">:development</span> <span class="k">do</span>
 <span class="n">gem</span> <span class="s1">'sqlite3'</span>
<span class="k">end</span>

<span class="n">group</span> <span class="ss">:production</span> <span class="k">do</span>
 <span class="n">gem</span> <span class="s1">'pg'</span>
<span class="k">end</span>
</pre> - <p> - Now, in development, you can instruct bundler to skip the <code>production</code> group: - </p> - <pre class="highlight plaintext">$ bundle install --without production
</pre> - <p> - Bundler will remember that you installed the gems using <code>--without - production</code>. For curious readers, bundler stores the flag in - <code>APP_ROOT/.bundle/config</code>. You can see all of the settings that bundler saved - there by running <code>bundle config</code>, which will also print out global settings - (stored in <code>~/.bundle/config</code>), and settings set via environment variables. - For more information on configuring bundler, please see - <a href="/v1.2/bundle_config.html">bundle config</a>. - </p> - <p> - If you run <code>bundle install</code> later, without any flag, bundler will remember - that you last called <code>bundle install --without production</code>, and use that flag - again. When you <code>require 'bundler/setup'</code>, bundler will ignore gems in these - groups. - </p> - <p> - You can also specify which groups to automatically require through the parameters to - <code>Bundler.require</code>. The <code>:default</code> group includes all gems not - listed under any group. If you call <code>Bundler.require(:default, :development)</code>, - bundler will <code>require</code> all the gems in the <code>:default</code> group, as - well as the gems in the <code>:development</code> group. - </p> - <p> - By default, a Rails generated app calls <code>Bundler.require(:default, - Rails.env)</code> in your <code>application.rb</code>, which links the groups in your - <code>Gemfile</code> to the Rails environment. If you use other groups (not linked to a - Rails environment), you can add them to the call to <code>Bundler.require</code>, if you - want them to be automatically required. - </p> - <p> - Remember that you can always leave groups of gems out of <code>Bundler.require</code>, - and then require them manually using Ruby's <code>require</code> at the appropriate - place in your app. You might do this because requiring a certain gem takes some time, - and you don't need it every time you boot your application. - </p> - <h2 id='checking-your-code-into-version-control'> - Checking Your Code into Version Control - </h2> - <p> - After developing your application for a while, check in the application together with - the <code>Gemfile</code> and <code>Gemfile.lock</code> snapshot. Now, your repository - has a record of the exact versions of all of the gems that you used the last time you - know for sure that the application worked. Keep in mind that while your - <code>Gemfile</code> lists only three gems (with varying degrees of version strictness), - your application depends on dozens of gems, once you take into consideration all of the - implicit requirements of the gems you depend on. - </p> - <p> - This is important: <strong>the <code>Gemfile.lock</code> makes your application a single - package of both your own code and the third-party code it ran the last time you know for - sure that everything worked</strong>. Specifying exact versions of the third-party code - you depend on in your <code>Gemfile</code> would not provide the same guarantee, because - gems usually declare a range of versions for their dependencies. - </p> - <p> - The next time you run <code>bundle install</code> on the same machine, bundler will see - that it already has all of the dependencies you need, and skip the installation process. - </p> - <p> - Do not check in the <code>.bundle</code> directory, or any of the files inside it. Those - files are specific to each particular machine, and are used to persist installation options - between runs of the <code>bundle install</code> command. - </p> - <p> - If you have run <code>bundle pack</code>, the gems (although not the git gems) required - by your bundle will be downloaded into <code>vendor/cache</code>. Bundler can run without - connecting to the internet (or the Rubygems server) if all the gems you need are present - in that folder and checked in to your source control. This is an <strong>optional</strong> - step, and not recommended, due to the increase in size of your source control repository. - </p> - <h2 id='sharing-your-application-with-other-developers'> - Sharing Your Application With Other Developers - </h2> - <p> - When your co-developers (or you on another machine) check out your code, it will come - with the exact versions of all the third-party code your application used on the machine - that you last developed on (in the <code>Gemfile.lock</code>). When **they** run - <code>bundle install</code>, bundler will find the <code>Gemfile.lock</code> and skip - the dependency resolution step. Instead, it will install all of the same gems that you - used on the original machine. - </p> - <p> - In other words, you don't have to guess which versions of the dependencies you should - install. In the example we've been using, even though <code>rack-cache</code> declares a - dependency on <code>rack >= 0.4</code>, we know for sure it works with <code>rack - 1.2.1</code>. Even if the Rack team releases <code>rack 1.2.2</code>, bundler will - always install <code>1.2.1</code>, the exact version of the gem that we know works. This - relieves a large maintenance burden from application developers, because all machines - always run the exact same third-party code. - </p> - <h2 id='updating-a-dependency'> - Updating a Dependency - </h2> - <p> - Of course, at some point, you might want to update the version of a particular - dependency your application relies on. For instance, you might want to update - <code>rails</code> to <code>3.0.0</code> final. Importantly, just because you're - updating one dependency, it doesn't mean you want to re-resolve all of your dependencies - and use the latest version of everything. In our example, you only have three - dependencies, but even in this case, updating everything can cause complications. - </p> - <p> - To illustrate, the <code>rails 3.0.0.rc</code> gem depends on <code>actionpack - 3.0.0.rc</code> gem, which depends on <code>rack ~> 1.2.1</code> (which means <code>>= - 1.2.1</code> and <code>< 1.3.0</code>). The <code>rack-cache</code> gem depends on - <code>rack >= 0.4</code>. Let's assume that the <code>rails 3.0.0</code> final gem also - depends on <code>rack ~> 1.2.1</code>, and that since the release of <code>rails - 3.0.0</code>, the Rack team released <code>rack 1.2.2</code>. - </p> - <p> - If we naïvely update all of our gems in order to update Rails, we'll get <code>rack - 1.2.2</code>, which satisfies the requirements of both <code>rails 3.0.0</code> and - <code>rack-cache</code>. However, we didn't specifically ask to update - <code>rack-cache</code>, which may not be compatible with <code>rack 1.2.2</code> (for - whatever reason). And while an update from <code>rack 1.2.1</code> to <code>rack - 1.2.2</code> probably won't break anything, similar scenarios can happen that involve - much larger jumps. (see [1] below for a larger discussion) - </p> - <p> - In order to avoid this problem, when you update a gem, bundler will not update a - dependency of that gem if another gem still depends on it. In this example, since - <code>rack-cache</code> still depends on <code>rack</code>, bundler will not update the - <code>rack</code> gem. This ensures that updating <code>rails</code> doesn't - inadvertently break <code>rack-cache</code>. Since <code>rails 3.0.0</code>'s dependency - <code>actionpack 3.0.0</code> remains compatible with <code>rack 1.2.1</code>, bundler - leaves it alone, and <code>rack-cache</code> continues to work even in the face of an - incompatibility with <code>rack 1.2.2</code>. - </p> - <p> - Since you originally declared a dependency on <code>rails 3.0.0.rc</code>, if you want - to update to <code>rails 3.0.0</code>, simply update your <code>Gemfile</code> to - <code>gem 'rails', '3.0.0'</code> and run: - </p> - <pre class="highlight plaintext">$ bundle install
</pre> - <p> - As described above, the <code>bundle install</code> command always does a conservative - update, refusing to update gems (or their dependencies) that you have not explicitly - changed in the <code>Gemfile</code>. This means that if you do not modify - <code>rack-cache</code> in your <code>Gemfile</code>, bundler will treat it **and its - dependencies** (<code>rack</code>) as a single, unmodifiable unit. If <code>rails - 3.0.0</code> was incompatible with <code>rack-cache</code>, bundler will report a - conflict between your snapshotted dependencies (<code>Gemfile.lock</code>) and your - updated <code>Gemfile</code>. - </p> - <p> - If you update your <code>Gemfile</code>, and your system already has all of the needed - dependencies, bundler will transparently update the <code>Gemfile.lock</code> when you - boot your application. For instance, if you add <code>mysql</code> to your - <code>Gemfile</code>, and have already installed it in your system, you can boot your - application without running <code>bundle install</code>, and bundler will persist the - "last known good" configuration to the <code>Gemfile.lock</code> snapshot. - </p> - <p> - This can come in handy when adding or updating gems with minimal dependencies (database - drivers, <code>wirble</code>, <code>ruby-debug</code>). It will probably fail if you - update gems with significant dependencies (<code>rails</code>), or that a lot of gems - depend on (<code>rack</code>). If a transparent update fails, your application will fail - to boot, and bundler will print out an error instructing you to run <code>bundle - install</code>. - </p> - <h2 id='updating-a-gem-without-modyfying-the-gemfile'> - Updating a Gem Without Modifying the Gemfile - </h2> - <p> - Sometimes, you want to update a dependency without modifying the Gemfile. For example, - you might want to update to the latest version of <code>rack-cache</code>. Because you - did not declare a specific version of <code>rack-cache</code> in the - <code>Gemfile</code>, you might want to periodically get the latest version of - <code>rack-cache</code>. To do this, you want to use the <code>bundle update</code> - command: - </p> - <pre class="highlight plaintext">$ bundle update rack-cache
</pre> - <p> - This command will update <code>rack-cache</code> and its dependencies to the latest - version allowed by the <code>Gemfile</code> (in this case, the latest version - available). It will not modify any other dependencies. - </p> - <p> - It will, however, update dependencies of other gems if necessary. For instance, if the - latest version of <code>rack-cache</code> specifies a dependency on <code>rack >= - 1.2.2</code>, bundler will update <code>rack</code> to <code>1.2.2</code> even though - you have not asked bundler to update <code>rack</code>. If bundler needs to update a - gem that another gem depends on, it will let you know after the update has completed. - </p> - <p> - If you want to update every gem in the Gemfile to the latest possible versions, run: - </p> - <pre class="highlight plaintext">$ bundle update
</pre> - <p> - This will resolve dependencies from scratch, ignoring the <code>Gemfile.lock</code>. If - you do this, keep <code>git reset --hard</code> and your test suite in your back pocket. - Resolving all dependencies from scratch can have surprising results, especially if a - number of the third-party packages you depend on have released new versions since you - last did a full update. - </p> - <h2 id='deploying-your-application'> - Deploying Your Application - </h2> - <p> - When you run <code>bundle install</code>, bundler will (by default), install your gems - to your system repository of gems. This means that they will show up in <code>gem - list</code>. Additionally, if you are developing a number of applications, you will not - need to download and install gems in common for each application. This is nice for - development, but somewhat problematic for deployment. - </p> - <p> - In a deployment scenario, the Unix user you deploy with may not have access to install - gems to a system location. Even if the user does (or you use <code>sudo</code>), the - user that boots the application may not have access to them. For instance, Passenger - runs its Ruby subprocesses with the user <code>nobody</code>, a somewhat restricted - user. The tradeoffs in a deployment environment lean more heavily in favor of isolation - (even at the cost of a somewhat slower deploy-time <code>bundle install</code> when some - third-party dependencies have changed). - </p> - <p> - As a result, bundler comes with a <code>--deployment</code> flag that encapsulates the - best practices for using bundler in a deployment environment. These practices are based - on significant feedback we have received during the development of bundler, as well as a - number of bug reports that mostly reflected a misunderstanding of how to best configure - bundler for deployment. The <code>--deployment</code> flags adds the following defaults: - </p> - <ul> - <li> - Instead of installing gems to the system location, bundler will install gems to - <code>vendor/bundle</code> inside your application. Bundler will transparently remember - this location when you invoke it inside your application (with - <code>Bundler.setup</code> and <code>Bundler.require</code>). - </li> - <li> - Bundler will not use gems already installed to your system, even if they exist. - </li> - <li> - If you have run <code>bundle pack</code>, checked in the <code>vendor/cache</code> - directory, and do not have any git gems, Bundler will not contact the internet while - installing your bundle. - </li> - <li> - Bundler will require a <code>Gemfile.lock</code> snapshot, and fail if you did not - provide one. - </li> - <li> - Bundler will not transparently update your <code>Gemfile.lock</code> if it is out of - date with your <code>Gemfile</code> - </li> - </ul> - <p> - If you use Capistrano, you should symlink <code>vendor/bundle</code> to - <code>shared/vendor_bundle</code> so that bundler will share your installed gems between - deployments (making things zippy if you didn't make any changes), but still give you the - benefits of isolation from other applications. - </p> - <p> - By defaulting the bundle directory to <code>vendor/bundle</code>, and installing your - bundle as part of your deployment process, you can be sure that the same Unix user that - checked out your application also installed the third-party code your application needs. - This means that if Passenger (or Unicorn) can see your application, it can also see its - dependencies. - </p> - <p> - The <code>--deployment</code> flag requires an up-to-date <code>Gemfile.lock</code> to - ensure that the testing you have done (in development and staging) actually reflects the - code you put into production. You can run <code>bundle check</code> before deploying - your application to make sure that your <code>Gemfile.lock</code> is up-to-date. Note - that it will always be up-to-date if you have run <code>bundle install</code>, - successfully booted your application (or run your tests) since the last time you changed - your <code>Gemfile</code>. - </p> - <h2 id='faq-1'> - FAQ: Why Can't I Just Specify Only <code>=</code> Dependencies? - </h2> - <p> - <strong>Q:</strong> I understand the value of locking my gems down to specific versions, - but why can't I just specify <code>=</code> versions for all my dependencies in the - <code>Gemfile</code> and forget about the <code>Gemfile.lock</code>? - </p> - <p> - <strong>A:</strong> Many of your gems will have their own dependencies, and they are - unlikely to specify <code>=</code> dependencies. Moreover, it is probably unwise for - gems to lock down all of *their* dependencies so strictly. The <code>Gemfile.lock</code> - allows you to specify the versions of the dependencies that your application needs in - the <code>Gemfile</code>, while remembering all of the exact versions of third-party - code that your application used when it last worked correctly. - </p> - <p> - By specifying looser dependencies in your <code>Gemfile</code> (such as - <code>nokogiri ~> 1.4.2</code>), you gain the ability to run - <code>bundle update nokogiri</code>, and let bundler handle updating **only** - <code>nokogiri</code> and its dependencies to the latest version that still - satisfied the <code>~> 1.4.2</code> version requirement. This - also allows you to say "I want to use the current version of nokogiri" (<code>gem - 'nokogiri'</code> in your <code>Gemfile</code>) without having to look up the exact - version number, while still getting the benefits of ensuring that your application - always runs with exactly the same versions of all third-party code. - </p> - <h2 id='faq-2'> - FAQ: Why Can't I Just Submodule Everything? - </h2> - <p> - <strong>Q:</strong> I don't understand why I need bundler to manage my gems in this - manner. Why can't I just get the gems I need and stick them in submodules, then put each - of the submodules on the load path? - </p> - <p> - <strong>A:</strong> Unfortunately, that solution requires that you manually resolve all - of the dependencies in your application, including dependencies of dependencies. And - even once you do that successfully, you would need to redo that work if you wanted to - update a particular gem. For instance, if you wanted to update the <code>rails</code> - gem, you would need to find all of the gems that depended on dependencies of Rails - (<code>rack</code>, <code>erubis</code>, <code>i18n</code>, <code>tzinfo</code>, etc.), - and find new versions that satisfy the new versions of Rails' requirements. - </p> - <p> - Frankly, this is the sort of problem that computers are good at, and which you, a - developer, should not need to spend time doing. - </p> - <p> - More concerningly, if you made a mistake in the manual dependency resolution process, - you would not get any feedback about conflicts between different dependencies, resulting - in subtle runtime errors. For instance, if you accidentally stuck the wrong version of - <code>rack</code> in a submodule, it would likely break at runtime, when Rails or - another dependency tried to rely on a method that was not present. - </p> - <p> - Bottom line: even though it might seem simpler at first glance, it is decidedly - significantly more complex. - </p> - <h2 id='faq-3'> - FAQ: Why Is Bundler Downloading Gems From <code>--without</code> Groups? - </h2> - <p> - <strong>Q:</strong> I ran <code>bundle install --without production</code> and bundler - is still downloading the gems in the <code>:production</code> group. Why? - </p> - <p> - <strong>A:</strong> Bundler's <code>Gemfile.lock</code> has to contain exact versions of all - dependencies in your <code>Gemfile</code>, regardless of any options you pass in. If it - did not, deploying your application to production might change all your dependencies, - eliminating the benefit of Bundler. You could no longer be sure that your application - uses the same gems in production that you used to develop and test with. Additionally, - adding a dependency in production might result in an application that is impossible to - deploy. - </p> - <p> - For instance, imagine you have a production-only gem (let's call it - <code>rack-debugging</code>) that depends on <code>rack =1.1</code>. If we did not - evaluate the production group when you ran <code>bundle install --without - production</code>, you would deploy your application, only to receive an error that - <code>rack-debugging</code> conflicted with <code>rails</code> (which depends on - <code>actionpack</code>, which depends on <code>rack ~> 1.2.1</code>). - </p> - <p> - Another example: imagine a simple Rack application that has <code>gem 'rack'</code> in - the <code>Gemfile</code>. Again, imagine that you put <code>rack-debugging</code> in the - <code>:production</code> group. If we did not evaluate the <code>:production</code> - group when you installed via <code>bundle install --without production</code>, your app - would use <code>rack 1.2.1</code> in development, and you would learn, at deployment - time, that <code>rack-debugging</code> conflicts with the version of Rack that you - tested with. - </p> - <p> - In contrast, by evaluating the gems in **all** groups when you call <code>bundle - install</code>, regardless of the groups you actually want to use in that environment, - we will discover the <code>rack-debugger</code> requirement, and install <code>rack - 1.1</code>, which is also compatible with the <code>gem 'rack'</code> requirement in - your <code>Gemfile</code>. - </p> - <p> - In short, by always evaluating all of the dependencies in your Gemfile, regardless of - the dependencies you intend to use in a particular environment, you avoid nasty - surprises when switching to a different set of groups in a different environment. And - because we just download (but do not install) the gems, you won't have to worry about - the possibility of a difficult **installation** process for a gem that you only use in - production (or in development). - </p> - <h2 id='faq-4'> - FAQ: I Have a C Extension That Requires Special Flags to Install - </h2> - <p> - <strong>Q</strong>: I have a C extension gem, such as <code>mysql</code>, which requires - special flags in order to compile and install. How can I pass these flags into the - installation process for those gems? - </p> - <p> - <strong>A</strong>: First of all, this problem does not exist for the - <code>mysql2</code> gem, which is a drop-in replacement for the <code>mysql</code> gem. - In general, modern C extensions properly discover the needed headers. - </p> - <p> - If you really need to pass flags to a C extension, you can use the <code>bundle - config</code> command: - </p> - <pre class="highlight plaintext">$ bundle config build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config
</pre> - <p> - Bundler will store this configuration in <code>~/.bundle/config</code>, and bundler will - use the configuration for any <code>bundle install</code> performed by the same user. As - a result, once you specify the necessary build flags for a gem, you can successfully - install that gem as many times as necessary. - </p> - <h2 id='summary'> - Summary - </h2> - <h2>A Simple Bundler Workflow</h2> - <ul> - <li> - <p> - When you first create a Rails application, it already comes with a - <code>Gemfile</code>. For another kind of application (such as Sinatra), run: - </p> - <pre class="highlight plaintext">$ bundle init
</pre> - <p> - The <code>bundle init</code> command creates a simple <code>Gemfile</code> which you - can edit. - </p> - </li> - <li> - <p> - Next, add any gems that your application depends on. If you care which version of a - particular gem that you need, be sure to include an appropriate version restriction: - </p> - <pre class="highlight ruby"><span class="n">source</span> <span class="s1">'http://rubygems.org'</span>

<span class="n">gem</span> <span class="s1">'sinatra'</span><span class="p">,</span> <span class="s1">'~> 0.9.0'</span>
<span class="n">gem</span> <span class="s1">'rack-cache'</span>
<span class="n">gem</span> <span class="s1">'rack-bug'</span>
</pre> - </li> - <li> - <p> - If you don't have the gems installed in your system yet, run: - </p> - <pre class="highlight plaintext">$ bundle install
</pre> - </li> - <li> - <p> - To update a gem's version requirements, first modify the Gemfile: - </p> - <pre class="highlight ruby"><span class="n">source</span> <span class="s1">'http://rubygems.org'</span>

<span class="n">gem</span> <span class="s1">'sinatra'</span><span class="p">,</span> <span class="s1">'~> 1.0.0'</span>
<span class="n">gem</span> <span class="s1">'rack-cache'</span>
<span class="n">gem</span> <span class="s1">'rack-bug'</span>
</pre> - <p> - and then run: - </p> - <pre class="highlight plaintext">$ bundle install
</pre> - </li> - <li> - <p> - If <code>bundle install</code> reports a conflict between your <code>Gemfile</code> - and <code>Gemfile.lock</code>, run: - </p> - <pre class="highlight plaintext">$ bundle update sinatra
</pre> - <p> - This will update just the Sinatra gem, as well as any of its dependencies - </p> - </li> - <li> - <p> - To update all of the gems in your <code>Gemfile</code> to the latest possible - versions, run: - </p> - <pre class="highlight plaintext">$ bundle update
</pre> - </li> - <li> - Whenever your <code>Gemfile.lock</code> changes, always check it in to version - control. It keeps a history of the exact versions of all third-party code that you - used to successfully run your application. - </li> - <li> - <p> - When deploying your code to a staging or production server, first run your tests (or - boot your local development server), make sure you have checked in your - <code>Gemfile.lock</code> to version control. On the remote server, run: - </p> - <pre class="highlight plaintext">$ bundle install --deployment
</pre> - </li> - </ul> - <h2 id='notes'> - Notes - </h2> - <p> - [1] For instance, if <code>rails 3.0.0</code> depended on <code>rack 2.0</code>, that - gem would still satisfy the requirement of <code>rack-cache</code>, which declares - <code>>= 1.0</code> as a dependency. Of course, you could argue that - <code>rack-cache</code> is silly for depending on open-ended versions, but these - situations exist (extensively) in the wild, and projects often find themselves between a - rock and a hard place when deciding what version to depend on. Constrain the dependency - too much (<code>rack =1.2.1</code>) and you make it hard to use your project in other - compatible projects. Constrain it too little (<code>rack >= 1.0</code>) and a new - release of Rack may break your code. Using dependencies like <code>rack ~> 1.2.1</code> - and versioning code in a SemVer compliant way mostly solves this problem, but it assumes - universal compliance. Since Rubygems has over 100,000 packages, this assumption simply - doesn't hold in practice. - </p> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/rubygems.html b/v1.2/rubygems.html deleted file mode 100644 index ef6834abd1..0000000000 --- a/v1.2/rubygems.html +++ /dev/null @@ -1,106 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>Using Bundler with Rubygem gemspecs</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - If you're creating a gem from scratch, you can use bundler's built in gem skeleton to create a base gem for you to edit. - </div> - <div class='how'> - <pre class="highlight plaintext">$ bundle gem my_gem</pre> - <div class='notes'> - This will create a new directory named <code>my_gem</code> with your new gem skeleton. - </div> - </div> - </div> - <div class='bullet'> - <div class='description'> - If you already have a gem with a gemspec, you can generate a Gemfile for your gem. - </div> - <pre class="highlight plaintext">$ bundle init</pre> - <div class='notes'> - Then, add the following to your new Gemfile - </div> - <pre class="highlight ruby"><span class="n">gemspec</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Runtime dependencies in your gemspec are treated like base dependencies, and development dependencies are added by default to the group, <code>:development</code>. You can change that group with the <code>:development_group</code> option - </div> - <pre class="highlight ruby"><span class="n">gemspec</span> <span class="ss">:development_group</span> <span class="o">=></span> <span class="ss">:dev</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - As well, you can point to a specific gemspec using <code>:path</code>. If your gemspec is in <code>/gemspec/path</code>, use - </div> - <pre class="highlight ruby"><span class="n">gemspec</span> <span class="ss">:path</span> <span class="o">=></span> <span class="s1">'/gemspec/path'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - If you have multiple gemspecs in the same directory, specify which one you'd like to reference using <code>:name</code> - </div> - <pre class="highlight ruby"><span class="n">gemspec</span> <span class="ss">:name</span> <span class="o">=></span> <span class="s1">'my_awesome_gem'</span></pre> - <div class='notes'> - This will use <code>my_awesome_gem.gemspec</code> - </div> - </div> - <div class='bullet'> - <div class='description'> - That's it! Use bundler when developing your gem, and otherwise, use gemspecs normally! - </div> - <pre class="highlight plaintext">$ gem build my_gem.gemspec</pre> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/rubymotion.html b/v1.2/rubymotion.html deleted file mode 100644 index 03773dfb6d..0000000000 --- a/v1.2/rubymotion.html +++ /dev/null @@ -1,89 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>Using Bundler with RubyMotion</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - If you don't have a RubyMotion app yet, generate one. - </div> - <pre class="highlight plaintext">$ motion create myapp
$ cd myapp</pre> - </div> - <div class='bullet'> - <div class='description'> - You'll need to create a Gemfile. Here we're using bubblewrap. - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'bubble-wrap'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Then, set up your Rakefile to require your bundled gems at compile time. - Add this to the top of the file, right beneath the line <code>require 'motion/project'</code> - </div> - <pre class="highlight ruby"><span class="nb">require</span> <span class="s1">'bundler'</span>

<span class="no">Bundler</span><span class="p">.</span><span class="nf">require</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Next, install your dependencies: - <pre class="highlight plaintext">$ bundle install
</pre> - </div> - </div> - <div class='bullet'> - <div class='description'> - Now you can just compile your app as normal. - <pre class="highlight plaintext">$ rake</pre> - </div> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/sinatra.html b/v1.2/sinatra.html deleted file mode 100644 index d7100b44f9..0000000000 --- a/v1.2/sinatra.html +++ /dev/null @@ -1,76 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h2>Using Bundler with Sinatra</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - To use bundler with a Sinatra application, you only need to do two things. First, create a Gemfile. - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'sinatra'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Then, set up your config.ru file to load the bundle before it loads your Sinatra app. - </div> - <pre class="highlight ruby"><span class="nb">require</span> <span class="s1">'rubygems'</span>
<span class="nb">require</span> <span class="s1">'bundler'</span>

<span class="no">Bundler</span><span class="p">.</span><span class="nf">require</span>

<span class="nb">require</span> <span class="s1">'./my_sinatra_app'</span>
<span class="n">run</span> <span class="no">MySinatraApp</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - Start your development server with rackup, and Sinatra will be loaded via Bundler. - </div> - <pre class="highlight plaintext">$ rackup</pre> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> diff --git a/v1.2/whats_new.html b/v1.2/whats_new.html deleted file mode 100644 index 7c69f252a8..0000000000 --- a/v1.2/whats_new.html +++ /dev/null @@ -1,130 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <title>Bundler: The best way to manage a Ruby application's gems</title> - <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'> - <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'> - <link href='/images/favicon.png' rel='shortcut icon' type='image/png'> - <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id='body'> - <div id='header'> - <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a> - </div> - <div id='container'> - <div id='contents'> - <h1>What's New in each Release</h1> - <div class='buttons'> - <a href="/v1.6/whats_new.html#version16">Latest Version v1.6</a> - <a href="/v1.5/whats_new.html#version15">v1.5</a> - <a href="/v1.3/whats_new.html#version13">v1.3</a> - <a href="/v1.2/whats_new.html#version12">v1.2</a> - <a href="https://github.com/bundler/bundler/blob/master/CHANGELOG.md#110-mar-7-2012">v1.1</a> - <a href="https://github.com/bundler/bundler/blob/master/CHANGELOG.md#100-august-29-2010">v1.0</a> - </div> - <h2 id='version12'>What's New in v1.2</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - In this section, you'll find the major features introduced in the release. All the changes are documented in the Bundler 1.2 CHANGELOG. - <a href="https://github.com/bundler/bundler/blob/1-2-stable/CHANGELOG.md">CHANGELOG</a> - </div> - </div> - </div> - <h2 id='ruby-directive'>Specifying a Ruby Version</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - You can now specify the version of Ruby in the <code>Gemfile</code> like the following: - </div> - <pre class="highlight ruby"><span class="n">ruby</span> <span class="s1">'1.9.3'</span>
</pre> - </div> - <div class='bullet'> - <div class='description'> - That line declares that this application has a dependency on the Ruby VM that is ABI-compatible with 1.9.3. If the version check does not match, Bundler will raise an exception. This will ensure the running code matches. You can be more specific with the <code>:engine</code> and <code>:engine_version</code> options. - </div> - <pre class="highlight ruby"><span class="n">ruby</span> <span class="s1">'1.9.3'</span><span class="p">,</span> <span class="ss">:engine</span> <span class="o">=></span> <span class="s1">'jruby'</span><span class="p">,</span> <span class="ss">:engine_version</span> <span class="o">=></span> <span class="s1">'1.6.7'</span></pre> - <a href="/v1.2/gemfile_ruby.html">Learn More: Ruby Directive</a> - </div> - </div> - <h2 id='package-git-and-path-dependencies'>Package <code>:git</code> and <code>:path</code> Dependencies</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - The <code>bundle package</code> command can also package <code>:git</code> and - <code>:path</code> dependencies besides <code>.gem</code> files. This needs to be explicitly enabled - via the <code>--all</code> option. Once used, the <code>--all</code> option will be remembered. - </div> - <a href="/v1.2/bundle_package.html">Learn More: bundle pack</a> - </div> - </div> - <h2 id='local-git-repos'>Local Git Repos</h2> - <div class='contents'> - <div class='bullet'> - <div class='description'> - Now when developing against a remote git repository, you can use a local - git repo and keep the remote version for deployment. You can do this by - setting a local git override: - </div> - <pre class="highlight plaintext">bundle config local.GEM_NAME /path/to/local/git/repository
</pre> - </div> - <div class='bullet'> - <div class='description'> - For example, in order to use a local Rack repository, a developer could call: - </div> - <pre class="highlight plaintext">bundle config local.rack ~/Work/git/rack</pre> - <div class='description'> - and in your <code>Gemfile</code> you would set: - </div> - <pre class="highlight ruby"><span class="n">gem</span> <span class="s1">'rack'</span><span class="p">,</span> <span class="ss">:github</span> <span class="o">=></span> <span class="s1">'rack/rack'</span><span class="p">,</span> <span class="ss">:branch</span> <span class="o">=></span> <span class="s1">'master'</span></pre> - <div class='description'> - You'll need to reference a git branch, since Bundler will do checks to - ensure you don't work with invalid references. 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. - </div> - <a href="/v1.2/git.html#local">Learn More: Git</a> - </div> - </div> - </div> - </div> - </div> - <div id='footer'> - <img src="/images/emocow.png" /> - <img src="/images/panda.jpg" /> - <div class='spacer'></div> - <div id='credits'> - <p> - Many thanks to Bundler's <a href="/contributors.html">contributors</a> - and <a href="/sponsors.html">sponsors</a> - </p> - </div> - <div class='spacer'></div> - <img src="/images/bundler-small.png" /> - </div> - <a href='http://github.com/bundler/bundler/' id='github'> - <img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'> - </a> - <div id='prod-versions'> - Docs: - <a href="/v0.9/">v0.9</a> - <a href="/v1.0/">v1.0</a> - <a href="/v1.1/">v1.1</a> - <a class="current" href="/v1.2/">v1.2</a> - <a href="/v1.3/">v1.3</a> - <a href="/v1.5/index.html">v1.5</a> - <a href="/">v1.6</a> - </div> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-39559982-1', 'bundler.io'); - ga('send', 'pageview'); - </script> - </body> -</html> |