diff options
author | Colby Swandale <colby@taplaboratories.com> | 2017-05-09 20:24:31 +1000 |
---|---|---|
committer | Colby Swandale <colby@taplaboratories.com> | 2017-05-09 20:26:50 +1000 |
commit | 3035940992cd1604d22d2747d280f6032bb38d95 (patch) | |
tree | d7b2441c49a931f82ef1f1e28c522f99f7d54285 | |
parent | 7603b06bb1d36d0ffb70e88ea86febb5d49602e3 (diff) | |
download | bundler-3035940992cd1604d22d2747d280f6032bb38d95.tar.gz |
update comments in installer that was a bit out of datecolby/installer-documetnation
-rw-r--r-- | lib/bundler/installer.rb | 27 |
1 files changed, 15 insertions, 12 deletions
diff --git a/lib/bundler/installer.rb b/lib/bundler/installer.rb index cbfdddeaf7..2ccdc8597c 100644 --- a/lib/bundler/installer.rb +++ b/lib/bundler/installer.rb @@ -33,25 +33,26 @@ module Bundler # Runs the install procedures for a specific Gemfile. # - # Firstly, this method will check to see if Bundler.bundle_path exists - # and if not then will create it. This is usually the location of gems - # on the system, be it RVM or at a system path. + # Firstly, this method will check to see if `Bundler.bundle_path` exists + # and if not then Bundler will create the directory. This is usually the same + # location as RubyGems which typically is the `~/.gem` directory + # unless other specified. # - # Secondly, it checks if Bundler has been configured to be "frozen" + # Secondly, it checks if Bundler has been configured to be "frozen". # Frozen ensures that the Gemfile and the Gemfile.lock file are matching. # This stops a situation where a developer may update the Gemfile but may not run # `bundle install`, which leads to the Gemfile.lock file not being correctly updated. # If this file is not correctly updated then any other developer running # `bundle install` will potentially not install the correct gems. # - # Thirdly, Bundler checks if there are any dependencies specified in the Gemfile using - # Bundler::Environment#dependencies. If there are no dependencies specified then - # Bundler returns a warning message stating so and this method returns. + # Thirdly, Bundler checks if there are any dependencies specified in the Gemfile. + # If there are no dependencies specified then Bundler returns a warning message stating + # so and this method returns. # - # Fourthly, Bundler checks if the default lockfile (Gemfile.lock) exists, and if so - # then proceeds to set up a definition based on the default gemfile (Gemfile) and the - # default lock file (Gemfile.lock). However, this is not the case if the platform is different - # to that which is specified in Gemfile.lock, or if there are any missing specs for the gems. + # Fourthly, Bundler checks if the Gemfile.lock exists, and if so + # then proceeds to set up a definition based on the Gemfile and the Gemfile.lock. + # During this step Bundler will also download infomrmation about any new gems + # that are not in the Gemfile.lock and resolve any dependencies if needed. # # Fifthly, Bundler resolves the dependencies either through a cache of gems or by remote. # This then leads into the gems being installed, along with stubs for their executables, @@ -61,7 +62,9 @@ module Bundler # Sixthly, a new Gemfile.lock is created from the installed gems to ensure that the next time # that a user runs `bundle install` they will receive any updates from this process. # - # Finally: TODO add documentation for how the standalone process works. + # Finally, if the user has specified the standalone flag, Bundler will generate the needed + # require paths and save them in a `setup.rb` file. See `bundle standalone --help` for more + # information. def run(options) create_bundle_path |