document the 'internal' functions in rrd.h but mark them as deprecated, so

[rrdtool.git] / src / rrd_format.h

diff --git a/src/rrd_format.h b/src/rrd_format.h
index b8f0790..7f974cb 100644 (file)
--- a/src/rrd_format.h
+++ b/src/rrd_format.h
@@ -7,6 +7,18 @@
 #ifndef _RRD_FORMAT_H
 #define _RRD_FORMAT_H
 
+/* 
+ * _RRD_TOOL_H
+ *   We're building RRDTool itself.
+ *
+ * RRD_EXPORT_DEPRECATED
+ *   User is requesting internal function which need this struct. They have
+ *   been told that this will change and have agreed to adapt their programs.
+ */
+#if !defined(_RRD_TOOL_H) && !defined(RRD_EXPORT_DEPRECATED)
+# error "Do not include rrd_format.h directly. Include rrd.h instead!"
+#endif
+
 #include "rrd.h"
 
 /*****************************************************************************