From 09df26f453b88aafaddf53c08c740d32e1342336 Mon Sep 17 00:00:00 2001
From: Niko Tyni <ntyni@iki.fi>
Date: Wed, 16 Feb 2005 20:18:48 +0000
Subject: * announce smokeping version at startup * add matcher list to
 smokeping_config * make matcher names start with a capital letter * make
 probe names start with a capital letter * small doc updates * one more
 pod2html makefile fix

---
 doc/smokeping_extend.pod | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

(limited to 'doc/smokeping_extend.pod')

diff --git a/doc/smokeping_extend.pod b/doc/smokeping_extend.pod
index 831a3d1..eef0bf6 100644
--- a/doc/smokeping_extend.pod
+++ b/doc/smokeping_extend.pod
@@ -30,8 +30,7 @@ you should too. This document will thus concentrate on the latter case.
 The L<Smokeping::probes::skel|Smokeping::probes::skel> module is a non-functional probe that is intended
 to make a good basis for a new probe module. Copy the file, 
 C<lib/probes/skel.pm>, to a new name and just fill out the blanks :)
-Note that real probe modules must have at least one capital letter
-in their name.
+Note that the names of real probe modules must start with a capital letter.
 
 =head1 PROBE DOCUMENTATION
 
@@ -50,6 +49,15 @@ 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
 generated from the description of your variables. See below.
 
+Note that if you use 'here documents' ('<<') that have POD markup inside,
+you should escape the markup so that it doesn't show up in the embedded
+POD documentation. Most probes do it like this:
+
+ my $e = "=";
+ my $doc = <<DOC;
+ ${e}head1 SECTION TITLE
+ DOC
+
 =head1 PROBE DESCRIPTION
 
 The probe should offer the C<ProbeDesc> method that returns a short
-- 
cgit v1.2.3-24-g4f1b