bundler 1.0.0.rc.5 → 1.0.0.rc.6

data/lib/bundler/man/bundle-update.txt

@@ -0,0 +1,207 @@
+BUNDLE-UPDATE(1)					      BUNDLE-UPDATE(1)
+
+
+
+NAME
+       bundle-update - Update your gems to the latest available versions
+
+SYNOPSIS
+       bundle update *gems [--source=NAME]
+
+DESCRIPTION
+       Update  the  gems specified (all gems, if none are specified), ignoring
+       the previously installed gems specified in the  Gemfile.lock.  In  gen-
+       eral, you should use bundle install(1) bundle-install.1.html to install
+       the same exact gems and versions across machines.
+
+       You would use bundle update to explicitly update the version of a  gem.
+
+OPTIONS
+       --source=<name>
+	      The  name  of a :git or :path source used in the Gemfile(5). For
+	      instance,       with	 a	  :git	      source	    of
+	      http://github.com/rails/rails.git,  you would call bundle update
+	      --source rails
+
+UPDATING ALL GEMS
+       If you run bundle update 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.
+
+       Consider the following Gemfile(5):
+
+
+
+	   source "http://rubygems.org"
+
+	   gem "rails", "3.0.0.rc"
+	   gem "nokogiri"
+
+
+
+       When you run bundle install(1) bundle-install.1.html  the  first  time,
+       bundler	will  resolve  all  of the dependencies, all the way down, and
+       install what you need:
+
+
+
+	   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.
+
+
+
+       As you can see, even though you have just two gems in  the  Gemfile(5),
+       your  application  actually  needs  25  different gems in order to run.
+       Bundler remembers the exact versions it installed in Gemfile.lock.  The
+       next  time  you	run  bundle  install(1) bundle-install.1.html, bundler
+       skips the dependency resolution	and  installs  the  same  gems	as  it
+       installed last time.
+
+       After  checking in the Gemfile.lock into version control and cloning it
+       on another machine,  running  bundle  install(1)  bundle-install.1.html
+       will  still  install  the  gems that you installed last time. You don't
+       need to worry that a new release of erubis or mail changes the gems you
+       use.
+
+       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  Gem-
+       file(5).
+
+       To  do this, run bundle update, which will ignore the Gemfile.lock, 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 bundle update.
+
+UPDATING A LIST OF GEMS
+       Sometimes, you want to update a single gem in the Gemfile(5), and leave
+       the rest of the gems that you specified locked to the versions  in  the
+       Gemfile.lock.
+
+       For  instance,  in  the	scenario above, imagine that nokogiri releases
+       version 1.4.4, and you want to update it without updating Rails and all
+       of its dependencies. To do this, run bundle update nokogiri.
+
+       Bundler	will  update  nokogiri	and any of its dependencies, but leave
+       alone Rails and its dependencies.
+
+OVERLAPPING DEPENDENCIES
+       Sometimes, multiple gems declared in your Gemfile(5) are  satisfied  by
+       the  same  second-level	dependency. For instance, consider the case of
+       thin and rack-perftools-profiler.
+
+
+
+	   source "http://rubygems.org"
+
+	   gem "thin"
+	   gem "rack-perftools-profiler"
+
+
+
+       The thin gem depends on	rack  >=  1.0,	while  rack-perftools-profiler
+       depends on rack ~> 1.0. If you run bundle install, you get:
+
+
+
+	   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)
+
+
+
+       In this case, the two gems have their own set of dependencies, but they
+       share rack in common. If you  run  bundle  update  thin,  bundler  will
+       update  daemons, eventmachine and rack, which are dependencies of thin,
+       but  not   open4   or   perftools.rb,   which   are   dependencies   of
+       rack-perftools_profiler.  Note that bundle update thin will update rack
+       even though it's also a dependency of rack-perftools_profiler.
+
+       In short, when you update a  gem  using	bundle	update,  bundler  will
+       update  all  dependencies  of  that  gem, including those that are also
+       dependencies of another gem.
+
+       In this scenario, updating the thin version manually in the Gemfile(5),
+       and  then  running  bundle  install(1)  bundle-install.1.html will only
+       update daemons and eventmachine, but not rack.  For  more  information,
+       see  the  CONSERVATIVE  UPDATING  section  of  bundle  install(1)  bun-
+       dle-install.1.html.
+
+RECOMMENDED WORKFLOW
+       In general, when working with an application managed with bundler,  you
+       should use the following workflow:
+
+       o   After you create your Gemfile(5) for the first time, run
+
+	   $ bundle install
+
+       o   Check the resulting Gemfile.lock into version control
+
+	   $ git add Gemfile.lock
+
+       o   When  checking  out this repository on another development machine,
+	   run
+
+	   $ bundle install
+
+       o   When checking out this repository on a deployment machine, run
+
+	   $ bundle install --deployment
+
+       o   After changing the Gemfile(5) to reflect a  new  or	update	depen-
+	   dency, run
+
+	   $ bundle install
+
+       o   Make sure to check the updated Gemfile.lock into version control
+
+	   $ git add Gemfile.lock
+
+       o   If bundle install(1) bundle-install.1.html reports a conflict, man-
+	   ually update the specific gems that you changed in the Gemfile(5)
+
+	   $ bundle update rails thin
+
+       o   If you want to update all the gems to the latest possible  versions
+	   that still match the gems listed in the Gemfile(5), run
+
+	   $ bundle update
+
+
+
+
+
+
+				  August 2010		      BUNDLE-UPDATE(1)

data/lib/bundler/man/bundle.txt

@@ -0,0 +1,83 @@
+BUNDLE(1)							     BUNDLE(1)
+
+
+
+NAME
+       bundle - Ruby Dependency Management
+
+SYNOPSIS
+       bundle [--no-color] COMMAND [ARGS]
+
+DESCRIPTION
+       Bundler	manages  an application's dependencies through its entire life
+       across many machines systematically and repeatably.
+
+       See the bundler website http://gembundler.com for information  on  get-
+       ting  started,  and Gemfile(5) for more information on the Gemfile for-
+       mat.
+
+OPTIONS
+       --no-color
+	      Prints all output without color
+
+BUNDLE COMMANDS
+       We divide bundle subcommands into primary commands and utilities.
+
+PRIMARY COMMANDS
+       bundle install(1) bundle-install.1.html
+	      Install the gems specified by the Gemfile or Gemfile.lock
+
+       bundle update(1) bundle-update.1.html
+	      Update dependencies to their latest versions
+
+       bundle package(1) bundle-package.1.html
+	      Package the .gem files required by  your	application  into  the
+	      vendor/cache directory
+
+       bundle exec(1) bundle-exec.1.html
+	      Execute a script in the context of the current bundle
+
+       bundle config(1) bundle-config.1.html
+	      Specify and read configuration options for bundler
+
+UTILITIES
+       bundle check(1)
+	      Determine  whether  the  requirements  for  your application are
+	      installed and available to bundler
+
+       bundle list(1)
+	      Show all of the gems in the current bundle
+
+       bundle show(1)
+	      Show the source location of a particular gem in the bundle
+
+       bundle console(1)
+	      Start an IRB session in the context of the current bundle
+
+       bundle open(1)
+	      Open an installed gem in the editor
+
+       bundle viz(1)
+	      Generate a visual representation of your dependencies
+
+       bundle init(1)
+	      Generate a simple Gemfile, placed in the current directory
+
+       bundle gem(1)
+	      Create a simple gem, suitable for development with bundler
+
+OBSOLETE
+       These commands are obsolete and should no longer be used
+
+       o   bundle lock(1)
+
+       o   bundle unlock(1)
+
+       o   bundle cache(1)
+
+
+
+
+
+
+				  August 2010			     BUNDLE(1)

data/lib/bundler/man/gemfile.5

@@ -0,0 +1,343 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GEMFILE" "5" "August 2010" "" ""
+.
+.SH "NAME"
+\fBGemfile\fR \- A format for describing gem dependencies for Ruby programs
+.
+.SH "SYNOPSIS"
+A \fBGemfile\fR describes the gem dependencies required to execute associated Ruby code\.
+.
+.P
+Place the \fBGemfile\fR in the root of the directory containing the associated code\. For instance, in a Rails application, place the \fBGemfile\fR in the same directory as the \fBRakefile\fR\.
+.
+.SH "SYNTAX"
+A \fBGemfile\fR is evaluated as Ruby code, in a context which makes available a number of methods used to describe the gem requirements\.
+.
+.SH "SOURCES (#source)"
+At the top of the \fBGemfile\fR, add one line for each \fBRubygems\fR source that might contain the gems listed in the \fBGemfile\fR\.
+.
+.IP "" 4
+.
+.nf
+
+source "http://rubygems\.org"
+source "http://gems\.github\.com"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Each of these _source_s \fBMUST\fR be a valid Rubygems repository\.
+.
+.SH "GEMS (#gem)"
+Specify gem requirements using the \fBgem\fR method, with the following arguments\. All parameters are \fBOPTIONAL\fR unless otherwise specified\.
+.
+.SS "NAME (required)"
+For each gem requirement, list a single \fIgem\fR line\.
+.
+.IP "" 4
+.
+.nf
+
+gem "nokogiri"
+.
+.fi
+.
+.IP "" 0
+.
+.SS "VERSION"
+Each \fIgem\fR \fBMAY\fR have one or more version specifiers\.
+.
+.IP "" 4
+.
+.nf
+
+gem "nokogiri", ">= 1\.4\.2"
+gem "RedCloth", ">= 4\.1\.0", "< 4\.2\.0"
+.
+.fi
+.
+.IP "" 0
+.
+.SS "REQUIRE AS (:require)"
+Each \fIgem\fR \fBMAY\fR specify its main file, which should be used when autorequiring (\fBBundler\.require\fR)\.
+.
+.IP "" 4
+.
+.nf
+
+gem "sqlite3\-ruby", :require => "sqlite3"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+This defaults to the name of the gem itself\. For instance, these are identical:
+.
+.IP "" 4
+.
+.nf
+
+gem "nokogiri"
+gem "nokogiri", :require => "nokogiri"
+.
+.fi
+.
+.IP "" 0
+.
+.SS "GROUPS (:group or :groups)"
+Each \fIgem\fR \fBMAY\fR specify membership in one or more groups\. Any \fIgem\fR that does not specify membership in any group is placed in the \fBdefault\fR group\.
+.
+.IP "" 4
+.
+.nf
+
+gem "rspec", :group => :test
+gem "wirble", :groups => [:development, :test]
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The Bundler runtime allows its two main methods, \fBBundler\.setup\fR and \fBBundler\.require\fR, to limit their impact to particular groups\.
+.
+.IP "" 4
+.
+.nf
+
+# 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
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The Bundler CLI allows you to specify a list of groups whose gems \fBbundle install\fR should not install with the \fB\-\-without\fR option\. To specify multiple groups to ignore, specify a list of groups separated by spaces\.
+.
+.IP "" 4
+.
+.nf
+
+bundle install \-\-without test
+bundle install \-\-without development test
+.
+.fi
+.
+.IP "" 0
+.
+.P
+After running \fBbundle install \-\-without test\fR, bundler will remember that you excluded the test group in the last installation\. The next time you run \fBbundle install\fR, without any \fB\-\-without option\fR, bundler will recall it\.
+.
+.P
+Also, calling \fBBundler\.setup\fR with no parameters, or calling \fBrequire "bundler/setup"\fR will setup all groups except for the ones you excluded via \fB\-\-without\fR (since they are obviously not available)\.
+.
+.P
+Note that on \fBbundle install\fR, 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 Understanding Bundler \fIhttp://gembundler\.com/v1\.0/understanding\.html\fR\.
+.
+.SS "PLATFORMS (:platforms)"
+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 \fB\-\-without\fR install\-time flag to exclude groups of gems for other platforms\.
+.
+.P
+There are a number of \fBGemfile\fR platforms:
+.
+.TP
+\fBruby\fR
+C Ruby (MRI) or Rubinius, but \fBNOT\fR Windows
+.
+.TP
+\fBruby_18\fR
+\fIruby\fR \fBAND\fR version 1\.8
+.
+.TP
+\fBruby_19\fR
+\fIruby\fR \fBAND\fR version 1\.9
+.
+.TP
+\fBmri\fR
+Same as \fIruby\fR, but not Rubinius
+.
+.TP
+\fBmri_18\fR
+\fImri\fR \fBAND\fR version 1\.8
+.
+.TP
+\fBmri_19\fR
+\fImri\fR \fBAND\fR version 1\.9
+.
+.TP
+\fBjruby\fR
+JRuby
+.
+.TP
+\fBmswin\fR
+Windows
+.
+.P
+As with groups, you can specify one or more platforms:
+.
+.IP "" 4
+.
+.nf
+
+gem "weakling",   :platforms => :jruby
+gem "ruby\-debug", :platforms => :mri_18
+gem "nokogiri",   :platforms => [:mri_18, :jruby]
+.
+.fi
+.
+.IP "" 0
+.
+.P
+All operations involving groups (\fBbundle install\fR, \fBBundler\.setup\fR, \fBBundler\.require\fR) behave exactly the same as if any groups not matching the current platform were explicitly excluded\.
+.
+.SS "GIT (:git)"
+If necessary, you can specify that a gem is located at a particular git repository\. The repository can be public (\fBhttp://github\.com/rails/rails\.git\fR) or private (\fBgit@github\.com:rails/rails\.git\fR)\. If the repository is private, the user that you use to run \fBbundle install\fR \fBMUST\fR have the appropriate keys available in their \fB$HOME/\.ssh\fR\.
+.
+.P
+Git repositories are specified using the \fB:git\fR parameter\. The \fBgroup\fR, \fBplatforms\fR, and \fBrequire\fR options are available and behave exactly the same as they would for a normal gem\.
+.
+.IP "" 4
+.
+.nf
+
+gem "rails", :git => "git://github\.com/rails/rails\.git"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+A git repository \fBSHOULD\fR have at least one file, at the root of the directory containing the gem, with the extension \fB\.gemspec\fR\. This file \fBMUST\fR contain a valid gem specification, as expected by the \fBgem build\fR command\. It \fBMUST NOT\fR have any dependencies, other than on the files in the git repository itself and any built\-in functionality of Ruby or Rubygems\.
+.
+.P
+If a git repository does not have a \fB\.gemspec\fR, 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
+If a git repository does have a \fB\.gemspec\fR for the gem you attached it to, a version specifier, if provided, means that the git repository is only valid if the \fB\.gemspec\fR specifies a version matching the version specifier\. If not, bundler will print a warning\.
+.
+.IP "" 4
+.
+.nf
+
+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
+.
+.fi
+.
+.IP "" 0
+.
+.P
+If a git repository does \fBnot\fR have a \fB\.gemspec\fR for the gem you attached it to, a version specifier \fBMUST\fR be provided\. Bundler will use this version in the simple \fB\.gemspec\fR it creates\.
+.
+.P
+Git repositories support a number of additional options\.
+.
+.TP
+\fBbranch\fR, \fBtag\fR, and \fBref\fR
+You \fBMUST\fR only specify at most one of these options\. The default is \fB:branch => "master"\fR
+.
+.TP
+\fBsubmodules\fR
+Specify \fB:submodules => true\fR to cause bundler to expand any submodules included in the git repository
+.
+.P
+If a git repository contains multiple \fB\.gemspecs\fR, each \fB\.gemspec\fR represents a gem located at the same place in the file system as the \fB\.gemspec\fR\.
+.
+.IP "" 4
+.
+.nf
+
+|~rails                   [git root]
+| |\-rails\.gemspec         [rails gem located here]
+|~actionpack
+| |\-actionpack\.gemspec    [actionpack gem located here]
+|~activesupport
+| |\-activesupport\.gemspec [activesupport gem located here]
+\.\.\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+To install a gem located in a git repository, bundler changes to the directory containing the gemspec, runs \fBgem build name\.gemspec\fR and then installs the resulting gem\. The \fBgem build\fR command, which comes standard with Rubygems, evaluates the \fB\.gemspec\fR in the context of the directory in which it is located\.
+.
+.SS "PATH (:path)"
+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 \fBGemfile\fR\.
+.
+.P
+Similar to the semantics of the \fB:git\fR option, the \fB:path\fR option requires that the directory in question either contains a \fB\.gemspec\fR for the gem, or that you specify an explicit version that bundler should use\.
+.
+.P
+Unlike \fB:git\fR, bundler does not compile C extensions for gems specified as paths\.
+.
+.IP "" 4
+.
+.nf
+
+gem "rails", :path => "vendor/rails"
+.
+.fi
+.
+.IP "" 0
+.
+.SH "BLOCK FORM OF GIT, PATH, GROUP and PLATFORMS"
+The \fB:git\fR, \fB:path\fR, \fB:group\fR, and \fB:platforms\fR options may be applied to a group of gems by using block form\.
+.
+.IP "" 4
+.
+.nf
+
+git "git://github\.com/rails/rails\.git" do
+  gem "activesupport"
+  gem "actionpack"
+end
+
+platforms :ruby do
+  gem "ruby\-debug"
+  gem "sqlite3\-ruby"
+end
+
+group :development do
+  gem "wirble"
+  gem "faker"
+end
+.
+.fi
+.
+.IP "" 0
+.
+.P
+In the case of the \fBgit\fR block form, the \fB:ref\fR, \fB:branch\fR, \fB:tag\fR, and \fB:submodules\fR options may be passed to the \fBgit\fR method, and all gems in the block will inherit those options\.
+.
+.SH "SOURCE PRIORITY"
+When attempting to locate a gem to satisfy a gem requirement, bundler uses the following priority order:
+.
+.IP "1." 4
+The source explicitly attached to the gem (using \fB:path\fR or \fB:git\fR)
+.
+.IP "2." 4
+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 \fBrubygems\.org\fR
+.
+.IP "3." 4
+The sources specified via \fBsource\fR, in the order in which they were declared in the \fBGemfile\fR\.
+.
+.IP "" 0
+