[carton] 386/472: Add missing docs

[Lucas Kanashiro]

This is an automated email from the git hooks/post-receive script.

kanashiro-guest pushed a commit to branch master
in repository carton.

commit 475ce80e1d7b7bb3631aeea5e53bc197a995ffb7
Author: Tatsuhiko Miyagawa <miyagawa at bulknews.net>
Date:   Mon Aug 5 10:17:37 2013 -0700

    Add missing docs
---
 lib/Carton/Doc/Bundle.pod  | 17 +++++++++++++++++
 lib/Carton/Doc/Check.pod   |  7 +++----
 lib/Carton/Doc/Install.pod | 23 ++++++++++++++++++-----
 lib/Carton/Doc/Tree.pod    | 13 +++++++++++++
 4 files changed, 51 insertions(+), 9 deletions(-)

diff --git a/lib/Carton/Doc/Bundle.pod b/lib/Carton/Doc/Bundle.pod
new file mode 100644
index 0000000..d098164
--- /dev/null
+++ b/lib/Carton/Doc/Bundle.pod
@@ -0,0 +1,17 @@
+=head1 NAME
+
+Carton::Doc::Bundle - Bundle cached tarballs in vendor/cache
+
+=head1 SYNOPSIS
+
+  carton bundle
+
+=head1 DESCRIPTION
+
+This command bundles cached tarballs into C<vendor/cache>
+directory. These tarballs have been cached in C<local/cache> while
+resolving dependencies in the snapshot file.snapshot.
+
+Bundled modules can be committed to a version control system, or
+transferred to another host with scp/rsync etc. to use with C<carton
+install --cached>.
diff --git a/lib/Carton/Doc/Check.pod b/lib/Carton/Doc/Check.pod
index 96313d8..5283a7a 100644
--- a/lib/Carton/Doc/Check.pod
+++ b/lib/Carton/Doc/Check.pod
@@ -8,14 +8,13 @@ Carton::Doc::Check - Check if your cpanfile and local environment are in sync
 
 =head1 DESCRIPTION
 
-This command checks the consistency between your cpanfile and the
-local environment.
+This command checks the consistency between your C<cpanfile>,
+C<cpanfile.snapshot> and the local environment.
 
 =head2 MISSING MODULES
 
 If one or more of the modules specified in your I<cpanfile> are not
-found in your local environment, C<carton check> will warn you about
-this:
+found in your snapshot, C<carton check> will warn you about this:
 
   $ carton check
   Following dependencies are not satisfied.
diff --git a/lib/Carton/Doc/Install.pod b/lib/Carton/Doc/Install.pod
index 35bb111..6c09512 100644
--- a/lib/Carton/Doc/Install.pod
+++ b/lib/Carton/Doc/Install.pod
@@ -4,7 +4,7 @@ Carton::Doc::Install - Install the dependencies
 
 =head1 SYNOPSIS
 
-  carton install [--deployment] [--path=PATH] [--without develop]
+  carton install [--deployment] [--cached] [--path=PATH] [--without develop]
 
 =head1 DESCRIPTION
 
@@ -23,7 +23,7 @@ the modules.
 
 =back
 
-In either way, if you run C<carton install> for the first time
+If you run C<carton install> for the first time
 (i.e. I<cpanfile.snapshot> does not exist), carton will fetch all the
 modules specified, resolve dependencies and install all required
 modules from CPAN.
@@ -40,8 +40,8 @@ commit the changes as you update your dependencies.
 =head2 DEPLOYMENT MODE
 
 If you specify the C<--deployment> command line option or the
-I<cpanfile.snapshot> exists, carton will fetch all remote modules and use
-the dependencies specified in the I<cpanfile.snapshot> instead of resolving
+I<cpanfile.snapshot> exists, carton will only use the dependencies
+specified in the I<cpanfile.snapshot> instead of resolving
 dependencies.
 
 =head1 OPTIONS
@@ -50,7 +50,14 @@ dependencies.
 
 =item --deployment
 
-Force the deployment mode and carton will ignore I<cpanfile> contents.
+Force the deployment mode. See L</"DEPLOYMENT MODE"> above.
+
+=item --cache
+
+Locate distribution tarballs in C<vendor/cache> rather than fetching
+them from CPAN mirrors. This requires you to run C<carton bundle>
+prior to the deployment and commit or sync the content of C<vendor>
+directory to the other host you run C<carton install> on.
 
 =item --cpanfile
 
@@ -68,6 +75,12 @@ well as install directory (C<local>) and C<vendor/cache> relative to it.
 Specify the path to install modules to. Defaults to I<local> in the
 directory relative to where C<cpanfile> is.
 
+B<NOTE>: this option, as of version 1.0, is not preserved across
+multiple runs of C<carton install> or other commands such as C<carton
+list> or C<carton exec>. You can choose to set the path in
+C<PERL_CARTON_PATH> envrionment variable to persist it across
+commands.
+
 =item --without
 
 By default, C<carton install> will install all the phases for
diff --git a/lib/Carton/Doc/Tree.pod b/lib/Carton/Doc/Tree.pod
new file mode 100644
index 0000000..0080eef
--- /dev/null
+++ b/lib/Carton/Doc/Tree.pod
@@ -0,0 +1,13 @@
+=head1 NAME
+
+Carton::Doc::Tree - Show the tree of dependency graph
+
+=head1 SYNOPSIS
+
+  carton tree
+
+=head1 DESCRIPTION
+
+Displays the tree representation of dependency graph for your application.
+
+

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/carton.git