summaryrefslogtreecommitdiffabout
path: root/lib/Config/HAProxy.pm
Side-by-side diff
Diffstat (limited to 'lib/Config/HAProxy.pm') (more/less context) (ignore whitespace changes)
-rw-r--r--lib/Config/HAProxy.pm18
1 files changed, 10 insertions, 8 deletions
diff --git a/lib/Config/HAProxy.pm b/lib/Config/HAProxy.pm
index ff4fa8a..794a80f 100644
--- a/lib/Config/HAProxy.pm
+++ b/lib/Config/HAProxy.pm
@@ -16,7 +16,7 @@ use File::Spec;
use IPC::Cmd;
use Carp;
-our $VERSION = '1.01';
+our $VERSION = '1.03';
my %sections = (
global => 1,
@@ -429,10 +429,11 @@ Returns the last node in the tree.
=head2 lint
- $cfg->lint(%ARGS);
+ $cfg->lint(%hash);
-Configures syntax checking program to be run before saving. Takes a
-hash as argument. Allowed keys are:
+Configures configuration syntax check. The check will be run by the B<save>
+method prior to writing to the configuration file. Takes a hash as argument.
+Allowed keys are:
=over 4
@@ -442,7 +443,8 @@ If I<BOOL> is 0, disables syntax check. Default is 1.
=item B<command =E<gt> I<CMD>>
-Configures the command to use for syntax check. The command will be run as
+Defines the shell command to use for syntax check. The command will be run
+as
CMD FILE
@@ -452,7 +454,7 @@ Default command is B<haproxy -c -f>.
=item B<path =E<gt> I<PATH>>
-Sets the search path for the check program. I<PATH> is a colon-delimited
+Sets the search path for the syntax checker. I<PATH> is a colon-delimited
list of directories. Unless the first word of B<command> is an absolute
file name, it will be looked for in these directories. The first match
will be used. Default is system B<$PATH>.
@@ -467,8 +469,8 @@ Returns the command name.
Saves the parse tree in the configuration file. Syntax check will be run
prior to saving (unless previously disabled). If syntax errors are discovered,
-the method will B<croak> with the appropriate diagnostics, beginning with
-words C<Syntax check failed:>.
+the method will B<croak> with a diagnostic message starting with words
+C<Syntax check failed:>.
If I<%hash> contains a non-zero B<dry_run> value, B<save> will only run syntax
check, without actually saving the file. If B<$cfg-E<gt>lint(enable =E<gt> 0)>

Return to:

Send suggestions and report system problems to the System administrator.