From: Sebastian Harl <sh@tokkee.org>
Date: Thu, 21 Aug 2008 08:46:36 +0000 (+0200)
Subject: collectd-perl(5): Added a note about the stability of the API.
X-Git-Tag: collectd-4.5.0~59
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=bc4a61e67efe0479973b9e6f0a26fb5e7a670382;p=collectd.git

collectd-perl(5): Added a note about the stability of the API.

Signed-off-by: Sebastian Harl <sh@tokkee.org>
Signed-off-by: Florian Forster <octo@huhu.verplant.org>
---

diff --git a/src/collectd-perl.pod b/src/collectd-perl.pod
index 6396bc8e..dac80bf7 100644
--- a/src/collectd-perl.pod
+++ b/src/collectd-perl.pod
@@ -557,6 +557,14 @@ reasons. Therefore, END blocks are only executed once when collectd shuts
 down. You should not rely on END blocks anyway - use B<shutdown functions>
 instead.
 
+=item
+
+The perl plugin exports the internal API of collectd which is considered
+unstable and subject to change at any time. We try hard to not break backwards
+compatibility in the Perl API during the life cycle of one major release.
+However, this cannot be guaranteed at all times. Watch out for warnings
+dispatched by the perl plugin after upgrades.
+
 =back
 
 =head1 KNOWN BUGS