Add short documentation about bumping the ABI

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>

diff --git a/Makefile b/Makefile
index 27ef40b6503a6f9a8b7c6e450fd233e5a2c95466..95cb98ea450f102bad389c4d1319ce55aa765617 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -4,6 +4,8 @@ RELEASE=5.1
 KERNEL_MAJ=4
 KERNEL_MIN=15
 KERNEL_PATCHLEVEL=18
+# increment KREL if the ABI changes (abicheck target in debian/rules)
+# rebuild packages with new KREL and run 'make abiupdate'
 KREL=1
 
 PKGREL=18

diff --git a/README b/README
index 8e2cadeb31a6dfb74c630ff829adcf0368d21762..8ad73a57e86b2798c350c18bee8d5bcb665bcdb4 100644 (file)
--- a/README
+++ b/README
@@ -55,6 +55,21 @@ git clone git://git.proxmox.com/git/pve-firmware.git
 NOTES:
 ======
 
+ABI versions, package versions and package name:
+------------------------------------------------
+
+We follow debian's versioning w.r.t ABI changes:
+
+https://kernel-team.pages.debian.net/kernel-handbook/ch-versions.html
+https://wiki.debian.org/DebianKernelABIChanges
+
+The debian/rules file has a target comparing the build kernel's ABI against the
+version stored in the repository and indicates when an ABI bump is necessary.
+An ABI bump within one upstream version consists of incrementing the KREL
+variable in the Makefile, rebuilding the packages and running 'make abiupdate'
+(the 'abiupdate' target in 'Makefile' contains the steps for consistently
+updating the repository).
+
 Watchdog blacklist
 ------------------