Add UPGRADE instructions

2 files changed, 22 insertions, 1 deletions

diff --git a/README b/README
index b680f69..73c9cb0 100644
--- a/README
+++ b/README
@@ -1,4 +1,6 @@
-This is the ipset source tree. Follow the next steps to install ipset:
+This is the ipset source tree. Follow the next steps to install ipset.
+If you upgrade from an earlier 5.x release, please read the UPGRADE
+instructions too.
 
 0. You need the source tree of your kernel (version >= 2.6.34)
    and it have to be configured with ip6tables support enabled,
diff --git a/UPGRADE b/UPGRADE
new file mode 100644
index 0000000..f20810d
--- /dev/null
+++ b/UPGRADE
@@ -0,0 +1,19 @@
+ipset 5.x upgrade notices
+
+- From ipset 5.0-5.3 to 5.4:
+
+  Due to the source code reorganization, some macros were moved to
+  the netlink.patch. Therefore when upgrading, you have two choices:
+
+  a. force the application of the new netlink.patch
+
+     kernel-source-dir # patch -p1 -f < ipset-5.4-dir/netlink.patch
+
+  b. remove the earlier netlink.patch and apply the new one:
+
+     kernel-source-dir # patch -p1 -R < ipset-before-5.4-dir/netlink.patch
+     kernel-source-dir # patch -p1 < ipset-5.4-dir/netlink.patch
+
+  You do not need to recompile your kernel.
+
+  Of course the kernel modules in ipset-5.4 must be compiled and installed.