[carton] 79/472: documentations

[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 f9f77dbda7b5caf510f7963a87bcd922e4cc797c
Author: Tatsuhiko Miyagawa <miyagawa at bulknews.net>
Date:   Tue Jun 28 22:11:20 2011 -0400

    documentations
---
 lib/Carton/Doc/Check.pod     | 42 ++++++++++++++++++++++++++++++++++++++++++
 lib/Carton/Doc/Config.pod    | 32 ++++++++++++++++++++++++++++++++
 lib/Carton/Doc/Exec.pod      | 33 +++++++++++++++++++++++++++++++++
 lib/Carton/Doc/Install.pod   |  2 +-
 lib/Carton/Doc/Show.pod      | 12 ++++++++++++
 lib/Carton/Doc/Tree.pod      | 13 +++++++++++++
 lib/Carton/Doc/Uninstall.pod | 25 +++++++++++++++++++++++++
 lib/Carton/Doc/Version.pod   | 11 +++++++++++
 8 files changed, 169 insertions(+), 1 deletion(-)

diff --git a/lib/Carton/Doc/Check.pod b/lib/Carton/Doc/Check.pod
new file mode 100644
index 0000000..7b78284
--- /dev/null
+++ b/lib/Carton/Doc/Check.pod
@@ -0,0 +1,42 @@
+=head1 NAME
+
+Carton::Doc::Check - Check if your build file and local environment are in sync
+
+=head1 SYNOPSIS
+
+  carton check
+
+=head1 DESCRIPTION
+
+This command checks the consisntency between yoru build file and the
+local environment.
+
+=head2 MISSING MODULES
+
+If one of the modules specified in your build file such as
+I<Makefile.PL are not found in your local environment, C<carton check>
+will warn you about this:
+
+  $ carton check
+  Following dependencies are not satisfied. Run `carton install` to install them.
+  JSON (2.00)
+
+You can run C<carton install> again to reinstall these missing dependencies.
+
+=head2 UNUSED MODULES
+
+If one of the modules in the local environment (i.e. I<local> library
+path) are not specified in your build file, you'll get a warning like
+this:
+
+  $ carton check
+  Following modules are found in local but couldn't be tracked from your Makefile.PL
+  CGI.pm-3.55
+    FCGI-0.73
+
+This means you probably installed this module in an ad-hoc mode so you
+have to add it to I<Makefile.PL>, or you originally declared the
+dependencies but found out that you don't need it, so deleted from
+your build file. In that case you can uninstall the module with the
+L<uninstall|Plack::Doc::Uninstall> command.
+
diff --git a/lib/Carton/Doc/Config.pod b/lib/Carton/Doc/Config.pod
new file mode 100644
index 0000000..8edb808
--- /dev/null
+++ b/lib/Carton/Doc/Config.pod
@@ -0,0 +1,32 @@
+=head1 NAME
+
+Carton::Doc::Config - set and get configuration for carton
+
+=head1 SYNOPSIS
+
+  carton config
+  carton config key
+  carton config key value
+  carton config --unset key
+
+=head1 DESCRIPTION
+
+This command, much like C<git config> allows you to get and set config values for carton.
+
+=head1 OPTIONS
+
+=over 4
+
+=item --global
+
+Only loads and saves the config from your global config (C<$HOME/.carton/config>).
+
+=item --local
+
+Only loads and saves the config from your local config (C<.carton/config>).
+
+=item --unset
+
+Removes the key in the config.
+
+=back
diff --git a/lib/Carton/Doc/Exec.pod b/lib/Carton/Doc/Exec.pod
new file mode 100644
index 0000000..83ccc1a
--- /dev/null
+++ b/lib/Carton/Doc/Exec.pod
@@ -0,0 +1,33 @@
+=head1 NAME
+
+Carton::Doc::Exec - execute your script in a carton local environment
+
+=head1 SYNOPSIS
+
+  carton exec -Ilib -- perl myscript.pl
+
+=head1 DESCRIPTION
+
+This command allows you to run your script in an isolated carton local
+environment, which means the whole perl 5 library path C<@INC> are the
+only ones from perl's core library path, carton's library path
+(i.e. C<local/lib/perl5>) and the current directory.
+
+This is useful to make sure your scripts and application use the exact
+same versions of the modules in your lirbary path, and are not using
+any of the modules you accidentally installed into your system perl or
+perlbrew's site library path.
+
+=head1 OPTIONS
+
+=over 4
+
+=item -Ilib
+
+Like perl's C<-I> option, this allows you to specify the library path
+you want to pass to the script you're going to run. Because of the
+complexity of how perl's C<PERL5OPT> and C<-M> and C<-I> command line
+options are handled, you have to pass this option to the C<carton
+exec> command instead of the actual C<perl> command.
+
+=back
diff --git a/lib/Carton/Doc/Install.pod b/lib/Carton/Doc/Install.pod
index 2ff4c90..cef2b1c 100644
--- a/lib/Carton/Doc/Install.pod
+++ b/lib/Carton/Doc/Install.pod
@@ -72,7 +72,7 @@ latest version of CPAN, you can either use C<carton update> command,
 or specify the required version either in your build file or a command
 line argument:
 
- > carton install URI at 1.51
+ > carton install URI~1.51
  > carton update URI
 
  > cat Makefile.PL
diff --git a/lib/Carton/Doc/Show.pod b/lib/Carton/Doc/Show.pod
new file mode 100644
index 0000000..20618b4
--- /dev/null
+++ b/lib/Carton/Doc/Show.pod
@@ -0,0 +1,12 @@
+=head1 NAME
+
+Carton::Doc::Show - Show the module information
+
+=head1 SYNOPSIS
+
+  carton show Module
+
+=head1 DESCRIPTION
+
+Displays the information about modules, distribution and its versions.
+
diff --git a/lib/Carton/Doc/Tree.pod b/lib/Carton/Doc/Tree.pod
new file mode 100644
index 0000000..b6b0879
--- /dev/null
+++ b/lib/Carton/Doc/Tree.pod
@@ -0,0 +1,13 @@
+=head1 NAME
+
+Carton::Doc::Tree - List dependencies in a tree structure
+
+=head1 SYNOPSIS
+
+  carton tree
+
+=head1 DESCRIPTION
+
+List the dependencies and version information tracked in the
+I<carton.lock> file as a tree structure. This command is an alias for
+C<carton list --tree>
diff --git a/lib/Carton/Doc/Uninstall.pod b/lib/Carton/Doc/Uninstall.pod
new file mode 100644
index 0000000..e09002d
--- /dev/null
+++ b/lib/Carton/Doc/Uninstall.pod
@@ -0,0 +1,25 @@
+=head1 NAME
+
+Carton::Doc::Uninstall - uninstall modules from your local environment
+
+=head1 SYNOPSIS
+
+  carton uninstall Module
+
+=head1 DESCRIPTION
+
+This command allows you to uninstall modules and its dependencies from
+your local environment.
+
+You're only allowed to uninstall modules that are not dependent by
+other modules. So if you have a dependency tree like:
+
+  Dancer-2.1
+    URI-1.5
+  HTTP-Body-1.3
+    LWP-1.2
+      URI-1.4
+
+you can uninstall either I<HTTP::Body> or I<Dancer>, but when you
+uninstall I<Dancer>, because I<URI> is referenced by I<LWP>, it will
+uninstall only I<Dancer>.
diff --git a/lib/Carton/Doc/Version.pod b/lib/Carton/Doc/Version.pod
new file mode 100644
index 0000000..8ff36ad
--- /dev/null
+++ b/lib/Carton/Doc/Version.pod
@@ -0,0 +1,11 @@
+=head1 NAME
+
+Carton::Doc::Version - Display version
+
+=head1 SYNOPSIS
+
+  carton version
+
+=head1 DESCRIPTION
+
+This command displays the current version number of carton.

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