diff options
| -rw-r--r-- | doc/smokeping_extend.pod | 16 | ||||
| -rw-r--r-- | doc/smokeping_upgrade.pod | 2 | ||||
| -rw-r--r-- | lib/Smokeping/Examples.pm | 4 |
3 files changed, 19 insertions, 3 deletions
diff --git a/doc/smokeping_extend.pod b/doc/smokeping_extend.pod index 6ee0133..536ac77 100644 --- a/doc/smokeping_extend.pod +++ b/doc/smokeping_extend.pod @@ -10,8 +10,8 @@ and its probe modules. If it seems too complicated to understand, look at the existing modules for examples. Comments and proposed changes or additions are welcome. Please send -them to the smokeping-users mailing list. Patches against this file -are most appreciated. +them to the smokeping-users mailing list. Patches against the POD +source of this document are most appreciated. =head1 CHOOSING A BASE CLASS @@ -174,6 +174,18 @@ fails, don't put anything in the array. 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 +the probe manual), you can do so by adding it to the Smokeping::Examples +module. Look for the 'examples' subroutine and add your example there. + +Future versions of Smokeping might provide a way to embed examples in +the probe modules too. The author's motivation for implementing this +would be greatly increased by even a single demand for it, so please +speak up if you think you'd use it. + =head1 TIMEOUT HANDLING If you deal with timeouts (for example because your program offers a parameter diff --git a/doc/smokeping_upgrade.pod b/doc/smokeping_upgrade.pod index edb1d6c..75c1076 100644 --- a/doc/smokeping_upgrade.pod +++ b/doc/smokeping_upgrade.pod @@ -14,7 +14,7 @@ a description of the problems, preferably with notes on how to fix them, to the C<smokeping-users> mailing list, so they can be added to this document. The same applies to any problems you find with current versions that are not documented here, of course. Patch submissions -against this file are most appreciated. +against the POD source of this file are most appreciated. If a version is not listed, there are no known problems in upgrading to it from the previous release. diff --git a/lib/Smokeping/Examples.pm b/lib/Smokeping/Examples.pm index 623c632..e61eed2 100644 --- a/lib/Smokeping/Examples.pm +++ b/lib/Smokeping/Examples.pm @@ -29,6 +29,10 @@ separate module only because the latter is much too big already. It should be possible to include POD markup in the configuration explanations and have this module filter them away for the config files. +It might be nice for the probe module authors to be able to provide an +example configuration as part of the probe module instead of having to +modify Smokeping::Examples too. + =head1 COPYRIGHT Copyright 2005 by Niko Tyni. |