diff options
| author | Matthew Hively <[email protected]> | 2025-05-22 11:06:18 -0700 |
|---|---|---|
| committer | Hiroshi SHIBATA <[email protected]> | 2025-06-03 07:47:14 +0900 |
| commit | f4a5247ce4d5e9a764f884ad304970044ce29793 () | |
| tree | 7574b0f19f521913ede419d9f1553e4d2383d9e6 /lib/bundler | |
| parent | 1f894fa2cc4a3e7938732c4f1b930bf88130bb0c (diff) | |
[rubygems/rubygems] Clarify how BUNDLE_DEPLOYMENT, BUNDLE_FROZEN and BUNDLE_PATH are connected
https://.com/rubygems/rubygems/commit/9ed20bddab
34 files changed, 42 insertions, 43 deletions
@@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-ADD" "1" "March 2025" "" .SH "NAME" \fBbundle\-add\fR \- Add gem to the Gemfile and run bundle install .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-BINSTUBS" "1" "March 2025" "" .SH "NAME" \fBbundle\-binstubs\fR \- Install the binstubs of the listed gems .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-CACHE" "1" "March 2025" "" .SH "NAME" \fBbundle\-cache\fR \- Package your needed \fB\.gem\fR files into your application .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-CHECK" "1" "March 2025" "" .SH "NAME" \fBbundle\-check\fR \- Verifies if dependencies are satisfied by installed gems .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-CLEAN" "1" "March 2025" "" .SH "NAME" \fBbundle\-clean\fR \- Cleans up unused gems in your bundler directory .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-CONFIG" "1" "March 2025" "" .SH "NAME" \fBbundle\-config\fR \- Set bundler configuration options .SH "SYNOPSIS" @@ -115,7 +115,7 @@ The following is a list of all configuration keys and their purpose\. You can le .IP "\(bu" 4 \fBdefault_install_uses_path\fR (\fBBUNDLE_DEFAULT_INSTALL_USES_PATH\fR): Whether a \fBbundle install\fR without an explicit \fB\-\-path\fR argument defaults to installing gems in \fB\.bundle\fR\. .IP "\(bu" 4 -\fBdeployment\fR (\fBBUNDLE_DEPLOYMENT\fR): Disallow changes to the \fBGemfile\fR\. When the \fBGemfile\fR is changed and the lockfile has not been updated, running Bundler commands will be blocked\. .IP "\(bu" 4 \fBdisable_checksum_validation\fR (\fBBUNDLE_DISABLE_CHECKSUM_VALIDATION\fR): Allow installing gems even if they do not match the checksum provided by RubyGems\. .IP "\(bu" 4 @@ -131,7 +131,7 @@ The following is a list of all configuration keys and their purpose\. You can le .IP "\(bu" 4 \fBforce_ruby_platform\fR (\fBBUNDLE_FORCE_RUBY_PLATFORM\fR): Ignore the current machine's platform and install only \fBruby\fR platform gems\. As a result, gems with native extensions will be compiled from source\. .IP "\(bu" 4 -\fBfrozen\fR (\fBBUNDLE_FROZEN\fR): Disallow changes to the \fBGemfile\fR\. When the \fBGemfile\fR is changed and the lockfile has not been updated, running Bundler commands will be blocked\. Defaults to \fBtrue\fR when \fB\-\-deployment\fR is used\. .IP "\(bu" 4 \fBgem\._username\fR (\fBBUNDLE_GEM___USERNAME\fR): Sets a username or organization to be used in \fBREADME\fR file when you create a new gem via \fBbundle gem\fR command\. It can be overridden by passing an explicit \fB\-\-\-username\fR flag to \fBbundle gem\fR\. .IP "\(bu" 4 @@ -157,7 +157,7 @@ The following is a list of all configuration keys and their purpose\. You can le .IP "\(bu" 4 \fBonly\fR (\fBBUNDLE_ONLY\fR): A space\-separated list of groups to install only gems of the specified groups\. .IP "\(bu" 4 -\fBpath\fR (\fBBUNDLE_PATH\fR): The location on disk where all gems in your bundle will be located regardless of \fB$GEM_HOME\fR or \fB$GEM_PATH\fR values\. Bundle gems not found in this location will be installed by \fBbundle install\fR\. Defaults to \fBGem\.dir\fR\. When \-\-deployment is used, defaults to vendor/bundle\. .IP "\(bu" 4 \fBpath\.system\fR (\fBBUNDLE_PATH__SYSTEM\fR): Whether Bundler will install gems into the default system path (\fBGem\.dir\fR)\. .IP "\(bu" 4 @@ -170,8 +170,7 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html). Whether a `bundle install` without an explicit `--path` argument defaults to installing gems in `.bundle`. * `deployment` (`BUNDLE_DEPLOYMENT`): - Disallow changes to the `Gemfile`. When the `Gemfile` is changed and the - lockfile has not been updated, running Bundler commands will be blocked. * `disable_checksum_validation` (`BUNDLE_DISABLE_CHECKSUM_VALIDATION`): Allow installing gems even if they do not match the checksum provided by RubyGems. @@ -193,9 +192,10 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html). Ignore the current machine's platform and install only `ruby` platform gems. As a result, gems with native extensions will be compiled from source. * `frozen` (`BUNDLE_FROZEN`): - Disallow changes to the `Gemfile`. When the `Gemfile` is changed and the - lockfile has not been updated, running Bundler commands will be blocked. - Defaults to `true` when `--deployment` is used. * `gem._username` (`BUNDLE_GEM___USERNAME`): Sets a username or organization to be used in `README` file when you create a new gem via `bundle gem` command. It can be overridden by passing an @@ -233,8 +233,7 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html). * `path` (`BUNDLE_PATH`): The location on disk where all gems in your bundle will be located regardless of `$GEM_HOME` or `$GEM_PATH` values. Bundle gems not found in this location - will be installed by `bundle install`. Defaults to `Gem.dir`. When --deployment - is used, defaults to vendor/bundle. * `path.system` (`BUNDLE_PATH__SYSTEM`): Whether Bundler will install gems into the default system path (`Gem.dir`). * `path_relative_to_cwd` (`BUNDLE_PATH_RELATIVE_TO_CWD`) @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-CONSOLE" "1" "March 2025" "" .SH "NAME" \fBbundle\-console\fR \- Open an IRB session with the bundle pre\-loaded .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-DOCTOR" "1" "March 2025" "" .SH "NAME" \fBbundle\-doctor\fR \- Checks the bundle for common problems .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-ENV" "1" "March 2025" "" .SH "NAME" \fBbundle\-env\fR \- Print information about the environment Bundler is running under .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-EXEC" "1" "March 2025" "" .SH "NAME" \fBbundle\-exec\fR \- Execute a command in the context of the bundle .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-FUND" "1" "March 2025" "" .SH "NAME" \fBbundle\-fund\fR \- Lists information about gems seeking funding assistance .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-GEM" "1" "March 2025" "" .SH "NAME" \fBbundle\-gem\fR \- Generate a project skeleton for creating a rubygem .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-HELP" "1" "March 2025" "" .SH "NAME" \fBbundle\-help\fR \- Displays detailed help for each subcommand .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-INFO" "1" "March 2025" "" .SH "NAME" \fBbundle\-info\fR \- Show information for the given gem in your bundle .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-INIT" "1" "March 2025" "" .SH "NAME" \fBbundle\-init\fR \- Generates a Gemfile into the current working directory .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-INJECT" "1" "March 2025" "" .SH "NAME" \fBbundle\-inject\fR \- Add named gem(s) with version requirements to Gemfile .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-INSTALL" "1" "March 2025" "" .SH "NAME" \fBbundle\-install\fR \- Install the dependencies specified in your Gemfile .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-ISSUE" "1" "March 2025" "" .SH "NAME" \fBbundle\-issue\fR \- Get help reporting Bundler issues .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-LICENSES" "1" "March 2025" "" .SH "NAME" \fBbundle\-licenses\fR \- Print the license of all gems in the bundle .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-LIST" "1" "March 2025" "" .SH "NAME" \fBbundle\-list\fR \- List all the gems in the bundle .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-LOCK" "1" "March 2025" "" .SH "NAME" \fBbundle\-lock\fR \- Creates / Updates a lockfile without installing .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-OPEN" "1" "March 2025" "" .SH "NAME" \fBbundle\-open\fR \- Opens the source directory for a gem in your bundle .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-OUTDATED" "1" "March 2025" "" .SH "NAME" \fBbundle\-outdated\fR \- List installed gems with newer versions available .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-PLATFORM" "1" "March 2025" "" .SH "NAME" \fBbundle\-platform\fR \- Displays platform compatibility information .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-PLUGIN" "1" "March 2025" "" .SH "NAME" \fBbundle\-plugin\fR \- Manage Bundler plugins .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-PRISTINE" "1" "March 2025" "" .SH "NAME" \fBbundle\-pristine\fR \- Restores installed gems to their pristine condition .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-REMOVE" "1" "March 2025" "" .SH "NAME" \fBbundle\-remove\fR \- Removes gems from the Gemfile .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-SHOW" "1" "March 2025" "" .SH "NAME" \fBbundle\-show\fR \- Shows all the gems in your bundle, or the path to a gem .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-UPDATE" "1" "March 2025" "" .SH "NAME" \fBbundle\-update\fR \- Update your gems to the latest available versions .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-VERSION" "1" "March 2025" "" .SH "NAME" \fBbundle\-version\fR \- Prints Bundler version information .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE\-VIZ" "1" "March 2025" "" .SH "NAME" \fBbundle\-viz\fR \- Generates a visual dependency graph for your Gemfile .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "BUNDLE" "1" "March 2025" "" .SH "NAME" \fBbundle\fR \- Ruby Dependency Management .SH "SYNOPSIS" @@ -1,6 +1,6 @@ .\" generated with Ronn-NG/v0.10.1 .\" http://.com/apjanke/ronn-ng/tree/0.10.1 -.TH "GEMFILE" "5" "March 2025" "" .SH "NAME" \fBGemfile\fR \- A format for describing gem dependencies for Ruby programs .SH "SYNOPSIS" |