diff options
author | Niko Tyni <ntyni@iki.fi> | 2005-02-26 19:00:27 +0100 |
---|---|---|
committer | Niko Tyni <ntyni@iki.fi> | 2005-02-26 19:00:27 +0100 |
commit | 30f15c0632513caff0c322c4cf1a8a1e10d9865c (patch) | |
tree | d83bf1cf7da50186d2fa91c5fe65757e013e98fd | |
parent | 90caa79fbf5c6be6d42e2768d7a5868ac851895d (diff) | |
download | smokeping-30f15c0632513caff0c322c4cf1a8a1e10d9865c.tar.gz smokeping-30f15c0632513caff0c322c4cf1a8a1e10d9865c.tar.xz |
SYNOPSYS is really spelled SYNOPSIS. Shame on me.
-rw-r--r-- | doc/smokeping_extend.pod | 6 | ||||
-rw-r--r-- | lib/Smokeping/RRDtools.pm | 2 | ||||
-rw-r--r-- | lib/Smokeping/probes/base.pm | 14 | ||||
-rw-r--r-- | lib/Smokeping/probes/passwordchecker.pm | 2 |
4 files changed, 12 insertions, 12 deletions
diff --git a/doc/smokeping_extend.pod b/doc/smokeping_extend.pod index eef0bf6..402efac 100644 --- a/doc/smokeping_extend.pod +++ b/doc/smokeping_extend.pod @@ -46,7 +46,7 @@ manpage. The supported section names are C<name>, C<overview>, C<description>, C<authors>, C<notes>, C<bugs>, and C<see_also>. If you don't need a particular section, just leave it out. -The special sections C<synopsys> and C<variables> are automatically +The special sections C<synopsis> and C<variables> are automatically generated from the description of your variables. See below. Note that if you use 'here documents' ('<<') that have POD markup inside, @@ -114,7 +114,7 @@ Description of the variable. =item _example -An example value. This will be used in the SYNOPSYS section in the +An example value. This will be used in the SYNOPSIS section in the probe manual. =back @@ -185,7 +185,7 @@ That's it, you're done! =head1 EXAMPLE CONFIGURATIONS If you would like to provide a documented example configuration for your -probe (in addition to the automatically generated SYNOPSYS section in +probe (in addition to the automatically generated SYNOPSIS section in the probe manual), you can do so by adding it to the L<Smokeping::Examples|Smokeping::Examples> module. Look for the 'examples' subroutine and add your example there. diff --git a/lib/Smokeping/RRDtools.pm b/lib/Smokeping/RRDtools.pm index 7260cca..3363f55 100644 --- a/lib/Smokeping/RRDtools.pm +++ b/lib/Smokeping/RRDtools.pm @@ -4,7 +4,7 @@ package Smokeping::RRDtools; Smokeping::RRDtools - Tools for RRD file handling -=head1 SYNOPSYS +=head1 SYNOPSIS use Smokeping::RRDtools; use RRDs; diff --git a/lib/Smokeping/probes/base.pm b/lib/Smokeping/probes/base.pm index 8cc4def..4ae81b5 100644 --- a/lib/Smokeping/probes/base.pm +++ b/lib/Smokeping/probes/base.pm @@ -42,9 +42,9 @@ sub pod { my $class = shift; my $pod = ""; my $podhash = $class->pod_hash; - $podhash->{synopsys} = $class->pod_synopsys; + $podhash->{synopsis} = $class->pod_synopsis; $podhash->{variables} = $class->pod_variables; - for my $what (qw(name overview synopsys description variables authors notes bugs see_also)) { + for my $what (qw(name overview synopsis description variables authors notes bugs see_also)) { my $contents = $podhash->{$what}; next if not defined $contents or $contents eq ""; $pod .= "=head1 " . uc $what . "\n\n"; @@ -316,7 +316,7 @@ sub _makevars { return $to; } -sub pod_synopsys { +sub pod_synopsis { my $class = shift; my $classname = ref $class||$class; $classname =~ s/^Smokeping::probes:://; @@ -329,8 +329,8 @@ sub pod_synopsys { +$classname DOC - $pod .= $class->_pod_synopsys($probevars); - my $targetpod = $class->_pod_synopsys($targetvars); + $pod .= $class->_pod_synopsis($probevars); + my $targetpod = $class->_pod_synopsis($targetvars); $pod .= "\n # The following variables can be overridden in each target section\n$targetpod" if defined $targetpod and $targetpod ne ""; $pod .= <<DOC; @@ -353,8 +353,8 @@ DOC return $pod; } -# synopsys for one hash ref -sub _pod_synopsys { +# synopsis for one hash ref +sub _pod_synopsis { my $class = shift; my $vars = shift; my %mandatory; diff --git a/lib/Smokeping/probes/passwordchecker.pm b/lib/Smokeping/probes/passwordchecker.pm index 7633eba..d1cc128 100644 --- a/lib/Smokeping/probes/passwordchecker.pm +++ b/lib/Smokeping/probes/passwordchecker.pm @@ -31,7 +31,7 @@ for storing passwords and a method for accessing them. DOC description => <<DOC, -${e}head2 synopsys with more detail +${e}head2 synopsis with more detail SmokePing main configuration file: |