[libcode-tidyall-perl] 122/374: docs

[Jonas Smedegaard]

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

js pushed a commit to branch master
in repository libcode-tidyall-perl.

commit 174d1674cf7728d71312f1578eec06a9c7a206a1
Author: Jonathan Swartz <swartz at pobox.com>
Date:   Tue Jul 24 14:26:39 2012 -0700

    docs
---
 bin/tidyall         |   27 ++++++++++++++++-----------
 lib/Code/TidyAll.pm |   13 +++++++------
 2 files changed, 23 insertions(+), 17 deletions(-)

diff --git a/bin/tidyall b/bin/tidyall
index 495f2ed..9730699 100755
--- a/bin/tidyall
+++ b/bin/tidyall
@@ -142,16 +142,16 @@ depending on how you call it:
 
 =over
 
-=item tidyall file [file...]
+=item C<< tidyall file [file...] >>
 
 C<tidyall> will search upwards from the first file for C<tidyall.ini>.
 
-=item tidyall -a
+=item C<< tidyall -a >>
 
 C<tidyall> will search upwards from the current working directory for
 C<tidyall.ini>.
 
-=item tidyall -a --root-dir dir
+=item C<< tidyall -a --root-dir dir >>
 
 C<tidyall> will expect to find C<tidyall.ini> in the specified root directory.
 
@@ -185,11 +185,11 @@ Apply C<PerlTidy> with settings "-noll -it=2" to all *.pl, *.pm, and *.t files.
 =item *
 
 Apply C<PerlCritic> with severity 3 to all Perl modules somewhere underneath
-"lib/", except for C<lib/UtterHack.pm>.
+"lib/", except for "lib/UtterHack.pm".
 
 =item *
 
-Apply C<PodTidy> with default settings to all .pm and .pod files underneath
+Apply C<PodTidy> with default settings to all *.pm and *.pod files underneath
 "lib/".
 
 =back
@@ -212,7 +212,8 @@ automatically prefixed with C<Code::TidyAll::Plugin::> unless it begins with a
 
 =item select
 
-A L<File::Zglob|File::Zglob> pattern indicating which files to select, e.g.
+A required L<File::Zglob|File::Zglob> pattern indicating which files to select,
+e.g.
 
     # All .pl and .pm files somewhere under bin, lib and t
     select = {bin,lib,t}/**/*.p[lm]
@@ -222,13 +223,13 @@ A L<File::Zglob|File::Zglob> pattern indicating which files to select, e.g.
 
 The pattern is relative to the root directory and should have no leading slash.
 All standard glob characters (C<*>, C<?>, C<[]>, C<{}>) will work; in addition,
-C<**> can be used to represent zero or more directories. See C<File::Zglob>
-documentation for more details.
+C<**> can be used to represent zero or more directories. See
+L<File::Zglob|File::Zglob> documentation for more details.
 
 =item ignore
 
-A C<File::Zglob> pattern, of the same format described above, indicating which
-files to ignore.  This overrides C<select>. e.g.
+A L<File::Zglob|File::Zglob> pattern, of the same format described above,
+indicating which files to ignore.  This overrides C<select>. e.g.
 
     # All .pl files under bin, except under bin/tmp
     select = bin/**/*.pl
@@ -408,13 +409,17 @@ Or you could specify that it be run in all modes I<except> the editor:
     except_modes = editor
     ...
 
+If you specify neither C<only_modes> nor C<except_modes> for a plugin, then it
+will always run.
+
 =head1 LAST-PROCESSED CACHE
 
 C<tidyall> keeps track of each file's signature after it was last processed. On
 subsequent runs, it will only process a file if its signature has changed. The
 cache is kept in files under the data dir.
 
-You can turn off this behavior with C<--no-cache>.
+You can force a refresh of the cache with C<--refresh-cache>, or turn off the
+behavior entirely with C<--no-cache>.
 
 =head1 BACKUPS
 
diff --git a/lib/Code/TidyAll.pm b/lib/Code/TidyAll.pm
index e4e1b5c..49e5f02 100644
--- a/lib/Code/TidyAll.pm
+++ b/lib/Code/TidyAll.pm
@@ -565,15 +565,16 @@ You must still pass the relative I<path> from the root as the second argument,
 so that we know which plugins to apply. Return a
 L<Code::TidyAll::Result|Code::TidyAll::Result> object.
 
-=item find_conf_file (start_dir)
+=item plugins_for_path (path)
 
-Start in the I<start_dir> and work upwards, looking for a C<tidyall.ini>.
-Return the pathname if found or throw an error if not found.
+Given a relative I<path> from the root, return a list of
+L<Code::TidyAll::Plugin|Code::TidyAll::Plugin> objects that apply to it, or an
+empty list if no plugins apply.
 
-=item plugins_for_path (path)
+=item find_conf_file (start_dir)
 
-Given a relative I<path> from the root, return a list of Code::TidyAll::Plugin
-objects that apply to it, or an empty list if no plugins apply.
+Class method. Start in the I<start_dir> and work upwards, looking for a
+C<tidyall.ini>.  Return the pathname if found or throw an error if not found.
 
 =back
 

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