[libcode-tidyall-perl] 60/374: document mode

[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 a742ee29547d48fd8b8a55c6bb7bac957aca0486
Author: Jonathan Swartz <swartz at pobox.com>
Date:   Fri Jun 29 17:31:36 2012 -0700

    document mode
---
 bin/tidyall         |   11 +++++++++++
 lib/Code/TidyAll.pm |    2 ++
 2 files changed, 13 insertions(+)

diff --git a/bin/tidyall b/bin/tidyall
index 7fadc6b..099f8ae 100755
--- a/bin/tidyall
+++ b/bin/tidyall
@@ -94,6 +94,7 @@ tidyall - Your all-in-one code tidier and validator
 
  -a, --all        Process all files in the project
  -h, --help       Print help message
+ -m, --mode       Optional mode (e.g. "editor", "commit") indicating a subset of plugins to run
  -q, --quiet      Suppress output except for errors
  -v, --verbose    Show extra output
  --backup-ttl     When backup files can be purged. Defaults to "1h"
@@ -241,6 +242,16 @@ files to ignore.  This overrides C<select>. e.g.
     select = bin/**/*.pl
     ignore = bin/tmp/*.pl
 
+=item modes
+
+An optional list of modes, separated by whitespace, in which this plugin should
+run. e.g.
+
+    modes = editor commit
+
+When a mode is passed to C<tidyall> via C<-m> or C<--mode>, only the plugins
+with that mode will run. If no mode is passed to C<tidyall>, all plugins run.
+
 =item argv
 
 Many plugins (such as L<perltidy|Code::TidyAll::Plugin::PerlTidy>,
diff --git a/lib/Code/TidyAll.pm b/lib/Code/TidyAll.pm
index 505165c..aae3434 100644
--- a/lib/Code/TidyAll.pm
+++ b/lib/Code/TidyAll.pm
@@ -429,6 +429,8 @@ content.
 
 =item data_dir
 
+=item mode
+
 =item no_backups
 
 =item no_cache

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