summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorNick Holden <nick.r.holden@gmail.com>2018-01-31 20:27:38 -0800
committerNick Holden <nick.r.holden@gmail.com>2018-01-31 20:27:38 -0800
commita1d9c1b13ca1de6bdb02ee445df3f707c9cdc198 (patch)
tree229ed1600af56a66007bbbf518d228e1bef0a85f /man
parent5751b6f89c2f23eab53dd267b9a58b553040b400 (diff)
downloadbundler-a1d9c1b13ca1de6bdb02ee445df3f707c9cdc198.tar.gz
Expand on problems checked by bundle-doctor
Diffstat (limited to 'man')
-rw-r--r--man/bundle-doctor.ronn19
1 files changed, 13 insertions, 6 deletions
diff --git a/man/bundle-doctor.ronn b/man/bundle-doctor.ronn
index 5c1b1e993c..f28f2f4f98 100644
--- a/man/bundle-doctor.ronn
+++ b/man/bundle-doctor.ronn
@@ -1,5 +1,5 @@
-bundle-doctor(1) -- Checks for missing OS dependencies
-======================================================
+bundle-doctor(1) -- Checks the bundle for common problems
+=========================================================
## SYNOPSIS
@@ -8,10 +8,17 @@ bundle-doctor(1) -- Checks for missing OS dependencies
## DESCRIPTION
-Scan the OS dependencies of each of the gems requested in your
-Gemfile(5). If missing OS dependencies are detected, Bundler prints
-them and exists status 1. Otherwise, Bundler prints a success message
-and exists status 0.
+Checks your Gemfile and gem environment for common problems. If issues
+are detected, Bundler prints them and exists status 1. Otherwise,
+Bundler prints a success message and exists status 0.
+
+Examples of common problems caught by bundle-doctor include:
+
+* Invalid Bundler settings
+* Mismatched Ruby versions
+* Mismatched platforms
+* Uninstalled gems
+* Missing dependencies
## OPTIONS