diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn index 0f80d535a47..cff3591e0d6 100644 --- a/man/bundle-config.ronn +++ b/man/bundle-config.ronn @@ -8,8 +8,8 @@ bundle-config(1) -- Set bundler configuration options ## DESCRIPTION This command allows you to interact with bundler's configuration system. -Bundler retrieves its configuration from the local application (`app/.bundle/config), -environment variables, and the user's home directory (`~/.bundle/config), +Bundler retrieves its configuration from the local application (`app/.bundle/config`), +environment variables, and the user's home directory (`~/.bundle/config`), in that order of priority. Executing `bundle config` with no parameters will print a list of all @@ -47,11 +47,11 @@ After running this command, every time bundler needs to install the Configuration keys in bundler have two forms: the canonical form and the environment variable form. -For instance, passing the `--without` flag to `bundle install(1)` prevents -Bundler from installing certain groups specified in the Gemfile(5). Bundler +For instance, passing the `--without` flag to [bundle install(1)][bundle-install] +prevents Bundler from installing certain groups specified in the Gemfile(5). Bundler persists this value in `app/.bundle/config` so that calls to `Bundler.setup` do not try to find gems from the `Gemfile` that you didn't install. Additionally, -subsequent calls to `bundle install(1)` remember this setting and skip those +subsequent calls to [bundle install(1)][bundle-install] remember this setting and skip those groups. The canonical form of this configuration is `"without"`. To convert the canonical @@ -61,7 +61,7 @@ environment variable form of `"without"` is `BUNDLE_WITHOUT`. ## LIST OF AVAILABLE KEYS The following is a list of all configuration keys and their purpose. You can -learn more about their operation in `bundle install(1)`. +learn more about their operation in [bundle install(1)][bundle-install]. * `path` (`BUNDLE_PATH`): The location on disk to install gems. Defaults to `$GEM_HOME` in development @@ -82,7 +82,7 @@ learn more about their operation in `bundle install(1)`. `Gemfile`. In general, you should set these settings per-application by using the applicable -flag to the `bundle install(1)` command. +flag to the [bundle install(1)][bundle-install] command. You can set them globally either via environment variables or `bundle config`, whichever is preferable for your setup. If you use both, environment variables diff --git a/man/bundle-exec.ronn b/man/bundle-exec.ronn index b2fe9a25755..8797a556523 100644 --- a/man/bundle-exec.ronn +++ b/man/bundle-exec.ronn @@ -12,7 +12,7 @@ This command executes the command, making all gems specified in the Essentially, if you would normally have run something like `rspec spec/my_spec.rb`, and you want to use the gems specified -in the `Gemfile(5)` and installed via `bundle install(1)`, you +in the `Gemfile(5)` and installed via [bundle install(1)][bundle-install], you should run `bundle exec rspec spec/my_spec.rb`. Note that `bundle exec` does not require that an executable is @@ -20,7 +20,7 @@ available on your shell's `$PATH`. ## BUNDLE INSTALL --BINSTUBS -If you use the `--binstubs` flag in `bundle install(1)`, Bundler will +If you use the `--binstubs` flag in [bundle install(1)][bundle-install], Bundler will automatically create a directory (which defaults to `app_root/bin`) containing all of the executables available from gems in the bundle. @@ -72,10 +72,10 @@ If you had that version of gemcutter installed (even if you _also_ had a newer version without this problem), Rubygems would activate `gemcutter 0.5` and `json_pure `. -If your `Gemfile(5)` also contained `json_pure` (or a gem +If your Gemfile(5) also contained `json_pure` (or a gem with a dependency on `json_pure`), the latest version on your system might conflict with the version in your -`Gemfile(5)`, or the snapshot version in your `Gemfile.lock`. +Gemfile(5), or the snapshot version in your `Gemfile.lock`. If this happens, bundler will say: diff --git a/man/bundle-package.ronn b/man/bundle-package.ronn index f77e5368213..d8a709bfc90 100644 --- a/man/bundle-package.ronn +++ b/man/bundle-package.ronn @@ -8,7 +8,7 @@ bundle-package(1) -- Package your needed `.gem` files into your application ## DESCRIPTION Copy all of the `.gem` files needed to run the application into the -`vendor/cache` directory. In the future, when running `bundle install(1)`, +`vendor/cache` directory. In the future, when running [bundle install(1)][bundle-install], use the gems in the cache in preference to the ones on `rubygems.org`. ## GIT AND PATH GEMS @@ -19,8 +19,8 @@ change in the future. ## REMOTE FETCHING -By default, if you simply run `bundle install(1)` after running -`bundle package(1)`, bundler will still connect to `rubygems.org` +By default, if you simply run [bundle install(1)][bundle-install] after running +[bundle package(1)][bundle-package], bundler will still connect to `rubygems.org` to check whether a platform-specific gem exists for any of the gems in `vendor/cache`. diff --git a/man/bundle-update.ronn b/man/bundle-update.ronn index c701a36dfa3..cdf9f0697c0 100644 --- a/man/bundle-update.ronn +++ b/man/bundle-update.ronn @@ -9,7 +9,7 @@ bundle-update(1) -- Update your gems to the latest available versions Update the gems specified (all gems, if none are specified), ignoring the previously installed gems specified in the `Gemfile.lock`. In -general, you should use `bundle install(1)` to install the same exact +general, you should use [bundle install(1)][bundle-install] to install the same exact gems and versions across machines. You would use `bundle update` to explicitly update the version of a @@ -35,7 +35,7 @@ Consider the following Gemfile(5): gem "rails", "3.0.0.rc" gem "nokogiri" -When you run `bundle install(1)` the first time, bundler will resolve +When you run [bundle install(1)][bundle-install] 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/ @@ -69,11 +69,11 @@ all of the dependencies, all the way down, and install what you need: 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)`, bundler skips +it installed in `Gemfile.lock`. The next time you run [bundle install(1)][bundle-install], 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)` will _still_ install the gems that you installed +machine, running [bundle install(1)][bundle-install] 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. @@ -132,9 +132,9 @@ In this case, the two gems have their own set of dependencies, but they share 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)` will only update `daemons` and `eventmachine`, +and then running [bundle install(1)][bundle-install] will only update `daemons` and `eventmachine`, but not `rack`. For more information, see the `CONSERVATIVE UPDATING` section -of `bundle install(1)`. +of [bundle install(1)][bundle-install]. ## RECOMMENDED WORKFLOW @@ -165,7 +165,7 @@ use the following workflow: $ git add Gemfile.lock -* If `bundle install(1)` reports a conflict, manually update the specific +* If [bundle install(1)][bundle-install] reports a conflict, manually update the specific gems that you changed in the Gemfile(5) $ bundle update rails thin diff --git a/man/bundle.ronn b/man/bundle.ronn index 8ff559da663..df5efb62466 100644 --- a/man/bundle.ronn +++ b/man/bundle.ronn @@ -24,20 +24,20 @@ We divide `bundle` subcommands into primary commands and utilities. ## PRIMARY COMMANDS -* `bundle install(1)`: +* [bundle install(1)][bundle-install]: Install the gems specified by the `Gemfile` or `Gemfile.lock` -* `bundle update(1)`: +* [bundle update(1)][bundle-update]: Update dependencies to their latest versions -* `bundle package(1)`: +* [bundle package(1)][bundle-package]: Package the .gem files required by your application into the `vendor/cache` directory -* `bundle exec(1)`: +* [bundle exec(1)][bundle-exec]: Execute a script in the context of the current bundle -* `bundle config(1)`: +* [bundle config(1)][bundle-config]: Specify and read configuration options for bundler ## UTILITIES diff --git a/man/index.txt b/man/index.txt index d06d573612a..435fa4139b2 100644 --- a/man/index.txt +++ b/man/index.txt @@ -1,2 +1,6 @@ Gemfile(5) gemfile.5.ronn +bundle-install bundle-install.ronn bundle-update bundle-update.ronn +bundle-package bundle-package.ronn +bundle-exec bundle-exec.ronn +bundle-config bundle-config.ronn