Clarify bundle check behaviour in docs

rubygems · Apr 27, 2024 · c438c6d · c438c6d
1 parent 9312624
commit c438c6d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/bundler/lib/bundler/man/bundle-check.1 b/bundler/lib/bundler/man/bundle-check.1
@@ -9,6 +9,8 @@
 \fBcheck\fR searches the local machine for each of the gems requested in the Gemfile\. If all gems are found, Bundler prints a success message and exits with a status of 0\.
 .P
 If not, the first missing gem is listed and Bundler exits status 1\.
+.P
+If a gem in the Gemfile is installed on the local machine, but not yet listed in the lockfile, then the lockfile will be updated to include it\.
 .SH "OPTIONS"
 .TP
 \fB\-\-dry\-run\fR

diff --git a/bundler/lib/bundler/man/bundle-check.1.ronn b/bundler/lib/bundler/man/bundle-check.1.ronn
@@ -15,6 +15,9 @@ a status of 0.
 
 If not, the first missing gem is listed and Bundler exits status 1.
 
+If a gem in the Gemfile is installed on the local machine, but not yet listed
+in the lockfile, then the lockfile will be updated to include it.
+
 ## OPTIONS
 
 * `--dry-run`: