Skip to content

Commit 56a82a2

Browse files
committed
Document Bundler checksum behavior for default gems
Signed-off-by: Patrick Linnane <patrick@linnane.io>
1 parent baf6115 commit 56a82a2

2 files changed

Lines changed: 3 additions & 1 deletion

File tree

lib/bundler/man/bundle-config.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ Cooldown filtering depends on the gem server providing a per\-version \fBcreated
139139
.IP "\(bu" 4
140140
\fBlockfile\fR (\fBBUNDLE_LOCKFILE\fR): The path to the lockfile that bundler should use\. By default, Bundler adds \fB\.lock\fR to the end of the \fBgemfile\fR entry\. Can be set to \fBfalse\fR in the Gemfile to disable lockfile creation entirely (see gemfile(5))\.
141141
.IP "\(bu" 4
142-
\fBlockfile_checksums\fR (\fBBUNDLE_LOCKFILE_CHECKSUMS\fR): Whether Bundler should include a checksums section in new lockfiles, to protect from compromised gem sources\. Defaults to true\.
142+
\fBlockfile_checksums\fR (\fBBUNDLE_LOCKFILE_CHECKSUMS\fR): Whether Bundler should include a checksums section in new lockfiles, to protect from compromised gem sources\. Defaults to true\. Bundler's own checksum is only included when its \fB\.gem\fR file is cached, which may not be the case when Bundler is installed as a default gem\.
143143
.IP "\(bu" 4
144144
\fBno_build_extension\fR (\fBBUNDLE_NO_BUILD_EXTENSION\fR): Whether Bundler should skip building native extensions during installation\. When set, gems are installed without compiling their C extensions\. To build extensions later, unset this setting and run \fBbundle pristine <gem>\fR\.
145145
.IP "\(bu" 4

lib/bundler/man/bundle-config.1.ronn

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,8 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
230230
Gemfile to disable lockfile creation entirely (see gemfile(5)).
231231
* `lockfile_checksums` (`BUNDLE_LOCKFILE_CHECKSUMS`):
232232
Whether Bundler should include a checksums section in new lockfiles, to protect from compromised gem sources. Defaults to true.
233+
Bundler's own checksum is only included when its `.gem` file is cached, which
234+
may not be the case when Bundler is installed as a default gem.
233235
* `no_build_extension` (`BUNDLE_NO_BUILD_EXTENSION`):
234236
Whether Bundler should skip building native extensions during installation.
235237
When set, gems are installed without compiling their C extensions.

0 commit comments

Comments
 (0)