[libcode-tidyall-perl] 123/374: doc improvements
Jonas Smedegaard
js at alioth.debian.org
Sun Sep 29 22:26:01 UTC 2013
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 412a9092e13a280fe551d1bb5eb398449868abec
Author: Jonathan Swartz <swartz at pobox.com>
Date: Tue Jul 24 14:32:20 2012 -0700
doc improvements
---
lib/Code/TidyAll/SVN/Precommit.pm | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/lib/Code/TidyAll/SVN/Precommit.pm b/lib/Code/TidyAll/SVN/Precommit.pm
index a63bdf4..6bfc74a 100644
--- a/lib/Code/TidyAll/SVN/Precommit.pm
+++ b/lib/Code/TidyAll/SVN/Precommit.pm
@@ -156,7 +156,7 @@ to be tidyall'd
=head1 SYNOPSIS
- In /usr/local/repos/hooks/pre-commit in your svn repo:
+ In hooks/pre-commit in your svn repo:
#!/usr/bin/perl
use Code::TidyAll::SVN::Precommit;
@@ -170,7 +170,7 @@ to be tidyall'd
This module implements a L<Subversion pre-commit
hook|http://svnbook.red-bean.com/en/1.7/svn.ref.reposhooks.pre-commit.html>
-that checks if all files are tidied and valid according to L<tidyall|tidyall>>,
+that checks if all files are tidied and valid according to L<tidyall|tidyall>,
and rejects the commit if not.
=head1 METHODS
@@ -199,8 +199,8 @@ For each file, the hook will look upwards from the file's repo location and use
the first configuration file it finds.
By default, if C<tidyall.ini> cannot be found, or if a runtime error occurs, a
-warning is logged (see below) but the commit is allowed to proceed. This is so
-that unexpected problems do not prevent a team from committing code.
+warning is logged (see L</LOGGING> below) but the commit is allowed to proceed.
+This is so that unexpected problems do not prevent a team from committing code.
Passes mode = "commit" by default; see L<modes|tidyall/MODES>.
@@ -251,7 +251,8 @@ that occur. You can create a simple datestamped log file with
use Log::Any::Adapter (File => "/path/to/hooks/logs/tidyall.log");
-or do something fancier with one of the other Log::Any adapters.
+or do something fancier with one of the other L<Log::Any
+adapters|Log::Any::Adapter>.
Having a log file is especially useful with precommit hooks since there is no
way for the hook to send back output on a successful commit.
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libcode-tidyall-perl.git
More information about the Pkg-perl-cvs-commits
mailing list