correct installdeps docs to note it's following extra rules

miyagawa · Feb 12, 2017 · 5102a4e · 5102a4e
1 parent ae585f9
commit 5102a4e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/lib/App/cpanminus/script.pm b/lib/App/cpanminus/script.pm
@@ -869,7 +869,7 @@ Options:
   -n,--notest               Do not run unit tests
   --test-only               Run tests only, do not install
   -S,--sudo                 sudo to run install commands
-  --installdeps             Only install dependencies
+  --installdeps             Only install 'test' dependencies
   --showdeps                Only display direct dependencies
   --reinstall               Reinstall the distribution even if you already have the latest version installed
   --mirror                  Specify the base URL for the mirror (e.g. http://cpan.cpantesters.org/)
@@ -896,7 +896,7 @@ Examples:
   cpanm ~/dists/MyCompany-Enterprise-1.00.tar.gz            # install from a local file
   cpanm --interactive Task::Kensho                          # Configure interactively
   cpanm .                                                   # install from local directory
-  cpanm --installdeps .                                     # install all the deps for the current directory
+  cpanm --installdeps .                                     # install 'test' deps for the current directory
   cpanm -L extlib Plack                                     # install Plack and all non-core deps into extlib
   cpanm --mirror http://cpan.cpantesters.org/ DBI           # use the fast-syncing mirror
   cpanm -M https://cpan.metacpan.org App::perlbrew          # use only this secure mirror and its index

diff --git a/script/cpanm.PL b/script/cpanm.PL
@@ -42,7 +42,7 @@ cpanm - get, unpack build and install modules from CPAN
   cpanm ~/dists/MyCompany-Enterprise-1.00.tar.gz   # install from a local file
   cpanm --interactive Task::Kensho                 # Configure interactively
   cpanm .                                          # install from local directory
-  cpanm --installdeps .                            # install all the deps for the current directory
+  cpanm --installdeps .                            # install 'test' deps for the current directory
   cpanm -L extlib Plack                            # install Plack and all non-core deps into extlib
   cpanm --mirror http://cpan.cpantesters.org/ DBI  # use the fast-syncing mirror
   cpanm --from https://cpan.metacpan.org/ Plack    # use only the HTTPS mirror
@@ -108,6 +108,15 @@ controlled repository such as git.
 
   cpanm --installdeps .
 
+This only installs the dependencies of the phases build, test, and runtime; as
+it is assumed there is no configure step necessary if the distribution uses a
+cpanfile. This behavior can be changed with the options C<--notest>,
+C<--with-develop>, and C<--with-configure>; to exclude test phase, or include
+develop, or configure phase deps.
+
+If all you're looking for is to get the distribution built, with tests to be run
+at a later time, C<--test-only --notest> is a suitable solution.
+
 =item --look
 
 Download and unpack the distribution and then open the directory with