summaryrefslogtreecommitdiffstats
path: root/doc/v8compatibility.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/v8compatibility.html')
-rw-r--r--doc/v8compatibility.html39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/v8compatibility.html b/doc/v8compatibility.html
new file mode 100644
index 00000000..aedc755f
--- /dev/null
+++ b/doc/v8compatibility.html
@@ -0,0 +1,39 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><title>Compatibility notes for rsyslog v8</title>
+</head>
+<body>
+<h1>Compatibility Notes for rsyslog v8</h1>
+This document describes things to keep in mind when moving from v7 to v8. It
+does not list enhancements nor does it talk about compatibility concerns introduced
+by earlier versions (for this, see their respective compatibility documents). Its focus
+is primarily on what you need to know if you used v7 and want to use v8 without hassle.
+<p>Version 8 offers a completely rewritten core rsyslog engine. This resulted in
+a number of changes that are visible to users and (plugin) developers.
+Most importantly, pre-v8 plugins <b>do not longer work</b> and need to
+be updated to support the new calling interfaces. If you developed a plugin,
+be sure to review the developer section below.
+</p>
+<h2>What Developers need to Know</h2>
+<h3>output plugin interface</h3>
+<p>To support the new core engine, the output interface has been considerably
+changed. It is suggested to review some of the project-provided plugins for
+full details. In this doc, we describe the most important changes from a high
+level perspective.
+<p><b>RS_RET_SUSPENDED is no longer supported when creating an action instance</b>
+<p>This means a plugin must not try to establish any connections or the like
+before any of its processing entry points (like beginTransaction or doAction)
+is called. This was generally also the case von v7, but was not enforced in
+all cases. In v8, creating action creation fails if anything but RS_RET_OK
+is returned.
+
+
+<a href="http://www.rsyslog.com/g/BSD">rsyslog BSD blocks info</a>
+page for more information and how to upgrade your config.
+<p>[<a href="manual.html">manual index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
+
+<p><font size="2">This documentation is part of the
+<a href="http://www.rsyslog.com/">rsyslog</a> project.<br>
+Copyright &copy; 2013 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and
+<a href="http://www.adiscon.com/">Adiscon</a>. Released under the GNU GPL
+version 2 or higher.</font></p>
+</body></html>