diff options
Diffstat (limited to 'doc/smokeping_extend.pod')
-rw-r--r-- | doc/smokeping_extend.pod | 16 |
1 files changed, 14 insertions, 2 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 |