summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMatt Taggart <taggart@riseup.net>2017-02-10 15:06:16 -0800
committerMatt Taggart <taggart@riseup.net>2017-02-20 12:54:26 -0800
commit725b5bdc4c3e278ed34aee408a54a5453a04a41b (patch)
treef601554fbcc344b196e12fead2bd1ce547ea52ba /README.md
parent70bba04533e2b01584775448a3d04a76e0a1c12c (diff)
add some notes about deprecated features
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index e6fb027..4cb1a8a 100644
--- a/README.md
+++ b/README.md
@@ -74,6 +74,23 @@ module will not work:
CONFIG_PATH="/etc/shorewall/puppet:/etc/shorewall:/usr/share/shorewall"
+Warnings
+--------
+There are some features that have been deprecated upstream that may still be
+supported by this module on certain shorewall major version. Please note
+the following:
+
+* the blacklist file and option is deprecated and replaced by blrules
+* the rfc1918 file and norfc1918 option are deprecated
+* the tcrules file is deprecated, replaced by mangled
+* the routestopped file is deprecated and replaced by stoppedrules
+* as of shorewall 4.6.0, SECTION headers need a leading '?'
+
+You should migrate your own calls to this module to move to the currently
+supported methods, we will be dropping support for deprecated features as
+the available distribution version permit it.
+For more details see http://www.shorewall.net/upgrade_issues.htm
+
Documentation
-------------