Permalink
Browse files

use C<> for filenames

  • Loading branch information...
miyagawa committed Jun 26, 2011
1 parent 8df4265 commit 5a31e6926cb4d671e177fcbebb5f4dc6f5c65925
Showing with 39 additions and 39 deletions.
  1. +13 −13 README
  2. +13 −13 lib/Carton.pod
  3. +1 −1 lib/Carton/Doc/FAQ.pod
  4. +11 −11 lib/Carton/Doc/Install.pod
  5. +1 −1 lib/Carton/Doc/List.pod
View
26 README
@@ -32,9 +32,9 @@ DESCRIPTION
TUTORIAL
Initializing the environment
- carton will use ".carton" folder for local configuration and "local" to
- install modules. You're recommended to exclude these directories from
- the version control system.
+ carton will use the *.carton* directory for local configuration and the
+ *local* directory to install modules into. You're recommended to exclude
+ these directories from the version control system.
> carton check
> echo .carton/ >> .gitignore
@@ -44,7 +44,7 @@ TUTORIAL
Tracking the dependencies
You can manage the dependencies of your application via the standard
- "Makefile.PL" or "Build.PL".
+ *Makefile.PL* or *Build.PL*.
# Makefile.PL
use inc::Module::Install;
@@ -57,11 +57,11 @@ TUTORIAL
> carton install
- The modules are installed into your "local" directory, and the
+ The modules are installed into your *local* directory, and the
dependencies tree and version information are analyzed and saved into
- "carton.lock" in your directory.
+ *carton.lock* in your directory.
- Make sure you add "carton.lock" to your version controlled repository
+ Make sure you add *carton.lock* to your version controlled repository
and commit changes as you update dependencies.
> git commit -m "Added Plack and Starman" Makefile.PL carton.lock
@@ -72,18 +72,18 @@ TUTORIAL
> carton install Devel::NYTProf
> carton install AnyEvent::Redis
- carton will install these modules into "local" directory in the same
+ carton will install these modules into *local* directory in the same
way, and also can track and analyze the dependencies.
Deploying your application
Once you've done installing all the dependencies, you can push your
- application directory to a remote machine (excluding "local" and
- ".carton") and run the following command:
+ application directory to a remote machine (excluding *local* and
+ *.carton*) and run the following command:
> carton install
- This will look at the "carton.lock" and install the exact same versions
- of the dependencies into "local", and now your application is ready to
+ This will look at the *carton.lock* and install the exact same versions
+ of the dependencies into *local*, and now your application is ready to
run.
Bundling modules
@@ -93,7 +93,7 @@ TUTORIAL
> carton bundle
- will bundle these tarballs into "local/cache" directory, and
+ will bundle these tarballs into *local/cache* directory, and
> carton install --cached
View
@@ -38,9 +38,9 @@ for your Perl application.
=head2 Initializing the environment
-carton will use C<.carton> folder for local configuration and
-C<local> to install modules. You're recommended to exclude these
-directories from the version control system.
+carton will use the I<.carton> directory for local configuration and
+the I<local> directory to install modules into. You're recommended to
+exclude these directories from the version control system.
> carton check
> echo .carton/ >> .gitignore
@@ -51,7 +51,7 @@ directories from the version control system.
=head2 Tracking the dependencies
You can manage the dependencies of your application via the standard
-C<Makefile.PL> or C<Build.PL>.
+I<Makefile.PL> or I<Build.PL>.
# Makefile.PL
use inc::Module::Install;
@@ -64,11 +64,11 @@ And then you can install these dependencies via:
> carton install
-The modules are installed into your C<local> directory, and the
+The modules are installed into your I<local> directory, and the
dependencies tree and version information are analyzed and saved into
-C<carton.lock> in your directory.
+I<carton.lock> in your directory.
-Make sure you add C<carton.lock> to your version controlled
+Make sure you add I<carton.lock> to your version controlled
repository and commit changes as you update dependencies.
> git commit -m "Added Plack and Starman" Makefile.PL carton.lock
@@ -79,19 +79,19 @@ without managing the build file at all.
> carton install Devel::NYTProf
> carton install AnyEvent::Redis
-carton will install these modules into C<local> directory in the same
+carton will install these modules into I<local> directory in the same
way, and also can track and analyze the dependencies.
=head2 Deploying your application
Once you've done installing all the dependencies, you can push your
-application directory to a remote machine (excluding C<local> and
-C<.carton>) and run the following command:
+application directory to a remote machine (excluding I<local> and
+I<.carton>) and run the following command:
> carton install
-This will look at the C<carton.lock> and install the exact same
-versions of the dependencies into C<local>, and now your application
+This will look at the I<carton.lock> and install the exact same
+versions of the dependencies into I<local>, and now your application
is ready to run.
=head2 Bundling modules
@@ -102,7 +102,7 @@ available on CPAN, such as internal distribution aka DarkPAN.
> carton bundle
-will bundle these tarballs into C<local/cache> directory, and
+will bundle these tarballs into I<local/cache> directory, and
> carton install --cached
View
@@ -44,7 +44,7 @@ development mode and deployment mode.
Carton automatically maintains the L<carton.lock> file, which is meant
to be version controlled, inside your application directory. You don't
need a separate database or a directory to maintain tarballs outside
-your application. The C<carton.lock> file can always be generated out
+your application. The I<carton.lock> file can always be generated out
of the local library path, and carton can reproduce the tree using the
lock file on other machines.
View
@@ -23,37 +23,37 @@ install the modules given as arguments.
=item carton install (no arguments)
If you run C<carton install> without any arguments and if a build file
-(C<Makefile.PL> or C<Build.PL>) exists, carton will scan dependencies
+(I<Makefile.PL> or I<Build.PL>) exists, carton will scan dependencies
from the build file and install the modules.
=back
In either way, if you run C<carton install> for the first time
-(i.e. C<carton.lock> does not exist), carton will fetch all the
+(i.e. I<carton.lock> does not exist), carton will fetch all the
modules specified, resolve dependencies and install all required
modules from CPAN.
-If C<carton.lock> file does exist, carton will still try to install
+If I<carton.lock> file does exist, carton will still try to install
modules specified or updated in the build file, but uses
-C<carton.lock> for the dependency resolution, and then cascades to
+I<carton.lock> for the dependency resolution, and then cascades to
CPAN.
carton will analyze all the dependencies and their version
-information, and it is saved into C<carton.lock> file. It is important
-to add C<carton.lock> file into a version controlled repository and
+information, and it is saved into I<carton.lock> file. It is important
+to add I<carton.lock> file into a version controlled repository and
commit the changes as you update your dependencies.
=head2 DEPLOYMENT MODE
If you specify the C<--deployment> command line option or the
-C<carton.lock> exists and your build file does not exist, carton will
+I<carton.lock> exists and your build file does not exist, carton will
fetch all remote modules and use the dependencies specified in the
-C<carton.lock> instead of resolving dependencies.
+I<carton.lock> instead of resolving dependencies.
=head1 CONSERVATIVE UPDATE
C<carton install> doesn't update the modules already installed into
-C<local> library path as long as the version is satisfied.
+I<local> library path as long as the version is satisfied.
For example, one day you install URI-1.50 from CPAN:
@@ -79,7 +79,7 @@ line argument:
requires 'URI', 1.51;
Any of those will upgrade URI to the latest one from CPAN, and the
-version specified in the C<carton.lock> will be bumped.
+version specified in the I<carton.lock> will be bumped.
=head1 OPTIONS
@@ -91,6 +91,6 @@ Force the deployment mode and carton will ignore build file contents.
=item --path
-Specify the path to install modules to. Defaults to C<local> in the current directory.
+Specify the path to install modules to. Defaults to I<local> in the current directory.
=back
View
@@ -9,7 +9,7 @@ Carton::Doc::List - List dependencies tracked in the carton.lock file
=head1 DESCRIPTION
List the dependencies and version information tracked in the
-C<carton.lock> file. This command by default displays the name of the
+I<carton.lock> file. This command by default displays the name of the
distribution (e.g. I<Foo-Bar-0.01>) in a flat list.
=head1 OPTIONS

0 comments on commit 5a31e69

Please sign in to comment.