Skip to content

Commit

Permalink
package: drop PKG_VERSION for purely local packages
Browse files Browse the repository at this point in the history
In the package guidelines, PKG_VERSION is supposed to be used as
"The upstream version number that we're downloading", while
PKG_RELEASE is referred to as "The version of this package Makefile".
Thus, the variables in a strict interpretation provide a clear
distinction between "their" (upstream) version in PKG_VERSION and
"our" (local OpenWrt trunk) version in PKG_RELEASE.

For local (OpenWrt-only) packages, this implies that those will only
need PKG_RELEASE defined, while PKG_VERSION does not apply following
a strict interpretation. While the majority of "our" packages actually
follow that scheme, there are also some that mix both variables or
have one of them defined but keep them at "1".

This is misleading and confusing, which can be observed by the fact
that there typically either one of the variables is never bumped or
the choice of the variable to increase depends on the person doing the
change.

Consequently, this patch aims at clarifying the situation by
consistently using only PKG_RELEASE for "our" packages. To achieve
that, PKG_VERSION is removed there, bumping PKG_RELEASE where
necessary to ensure the resulting package version string is bigger
than before.

During adjustment, one has to make sure that the new resulting composite
package version will not be considered "older" than the previous one.

A useful tool for evaluating that is 'opkg compare-versions'. In
principle, there are the following cases:

1. Sole PKG_VERSION replaced by sole PKG_RELEASE:
   In this case, the resulting version string does not change, it's
   just the value of the variable put in the file. Consequently, we
   do not bump the number in these cases so nobody is tempted to
   install the same package again.

2. PKG_VERSION and PKG_RELEASE replaced by sole PKG_RELEASE:
   In this case, the resulting version string has been "version-release",
   e.g. 1-3 or 1.0-3. For this case, the new PKG_RELEASE will just
   need to be higher than the previous PKG_VERSION.
   For the cases where PKG_VERSION has always sticked to "1", and
   PKG_RELEASE has been incremented, we take the most recent value of
   PKG_RELEASE.

Apart from that, a few packages appear to have developed their own
complex versioning scheme, e.g. using x.y.z number for PKG_VERSION
_and_ a PKG_RELEASE (qos-scripts) or using dates for PKG_VERSION
(adb-enablemodem, wwan). I didn't touch these few in this patch.

Cc: Hans Dedecker <dedeckeh@gmail.com>
Cc: Felix Fietkau <nbd@nbd.name>
Cc: Andre Valentin <avalentin@marcant.net>
Cc: Matthias Schiffer <mschiffer@universe-factory.net>
Cc: Jo-Philipp Wich <jo@mein.io>
Cc: Steven Barth <steven@midlink.org>
Cc: Daniel Golle <dgolle@allnet.de>
Cc: John Crispin <john@phrozen.org>

Signed-off-by: Adrian Schmutzler <freifunk@adrianschmutzler.de>
  • Loading branch information
adschm committed Jul 15, 2020
1 parent b29d620 commit 9c170cb
Show file tree
Hide file tree
Showing 15 changed files with 8 additions and 22 deletions.
1 change: 0 additions & 1 deletion package/kernel/om-watchdog/Makefile
Expand Up @@ -9,7 +9,6 @@ include $(TOPDIR)/rules.mk

PKG_NAME:=om-watchdog
PKG_RELEASE:=2
PKG_VERSION:=1

include $(INCLUDE_DIR)/package.mk

Expand Down
1 change: 0 additions & 1 deletion package/kernel/trelay/Makefile
Expand Up @@ -9,7 +9,6 @@ include $(TOPDIR)/rules.mk
include $(INCLUDE_DIR)/kernel.mk

PKG_NAME:=trelay
PKG_VERSION:=0.1
PKG_RELEASE:=2

include $(INCLUDE_DIR)/package.mk
Expand Down
1 change: 0 additions & 1 deletion package/network/config/gre/Makefile
Expand Up @@ -8,7 +8,6 @@
include $(TOPDIR)/rules.mk

PKG_NAME:=gre
PKG_VERSION:=1
PKG_RELEASE:=12
PKG_LICENSE:=GPL-2.0

Expand Down
1 change: 0 additions & 1 deletion package/network/config/ipip/Makefile
Expand Up @@ -8,7 +8,6 @@
include $(TOPDIR)/rules.mk

PKG_NAME:=ipip
PKG_VERSION:=1
PKG_RELEASE:=3
PKG_LICENSE:=GPL-2.0

Expand Down
1 change: 0 additions & 1 deletion package/network/config/vti/Makefile
Expand Up @@ -8,7 +8,6 @@
include $(TOPDIR)/rules.mk

PKG_NAME:=vti
PKG_VERSION:=1
PKG_RELEASE:=3
PKG_LICENSE:=GPL-2.0

Expand Down
1 change: 0 additions & 1 deletion package/network/config/xfrm/Makefile
Expand Up @@ -2,7 +2,6 @@
include $(TOPDIR)/rules.mk

PKG_NAME:=xfrm
PKG_VERSION:=1
PKG_RELEASE:=2
PKG_LICENSE:=GPL-2.0

Expand Down
2 changes: 1 addition & 1 deletion package/network/ipv6/464xlat/Makefile
@@ -1,7 +1,7 @@
include $(TOPDIR)/rules.mk

PKG_NAME:=464xlat
PKG_VERSION:=12
PKG_RELEASE:=12

PKG_SOURCE_DATE:=2018-01-16
PKG_MAINTAINER:=Hans Dedecker <dedeckeh@gmail.com>
Expand Down
3 changes: 1 addition & 2 deletions package/network/ipv6/6in4/Makefile
Expand Up @@ -8,8 +8,7 @@
include $(TOPDIR)/rules.mk

PKG_NAME:=6in4
PKG_VERSION:=25
PKG_RELEASE:=1
PKG_RELEASE:=26
PKG_LICENSE:=GPL-2.0

include $(INCLUDE_DIR)/package.mk
Expand Down
3 changes: 1 addition & 2 deletions package/network/ipv6/6rd/Makefile
Expand Up @@ -8,8 +8,7 @@
include $(TOPDIR)/rules.mk

PKG_NAME:=6rd
PKG_VERSION:=9
PKG_RELEASE:=4
PKG_RELEASE:=10
PKG_LICENSE:=GPL-2.0

include $(INCLUDE_DIR)/package.mk
Expand Down
3 changes: 1 addition & 2 deletions package/network/ipv6/6to4/Makefile
Expand Up @@ -8,8 +8,7 @@
include $(TOPDIR)/rules.mk

PKG_NAME:=6to4
PKG_VERSION:=12
PKG_RELEASE:=2
PKG_RELEASE:=13
PKG_LICENSE:=GPL-2.0

include $(INCLUDE_DIR)/package.mk
Expand Down
3 changes: 1 addition & 2 deletions package/network/ipv6/ds-lite/Makefile
Expand Up @@ -8,8 +8,7 @@
include $(TOPDIR)/rules.mk

PKG_NAME:=ds-lite
PKG_VERSION:=7
PKG_RELEASE:=4
PKG_RELEASE:=8
PKG_LICENSE:=GPL-2.0

include $(INCLUDE_DIR)/package.mk
Expand Down
3 changes: 1 addition & 2 deletions package/network/ipv6/map/Makefile
Expand Up @@ -8,8 +8,7 @@
include $(TOPDIR)/rules.mk

PKG_NAME:=map
PKG_VERSION:=4
PKG_RELEASE:=13
PKG_RELEASE:=5
PKG_LICENSE:=GPL-2.0

include $(INCLUDE_DIR)/package.mk
Expand Down
3 changes: 1 addition & 2 deletions package/network/utils/rssileds/Makefile
Expand Up @@ -8,8 +8,7 @@
include $(TOPDIR)/rules.mk

PKG_NAME:=rssileds
PKG_VERSION:=0.2
PKG_RELEASE:=2
PKG_RELEASE:=3
PKG_LICNESE:=GPL-2.0+

include $(INCLUDE_DIR)/package.mk
Expand Down
1 change: 0 additions & 1 deletion package/system/urandom-seed/Makefile
@@ -1,7 +1,6 @@
include $(TOPDIR)/rules.mk

PKG_NAME:=urandom-seed
PKG_VERSION:=1.0
PKG_RELEASE:=2
PKG_LICENSE:=GPL-2.0-only

Expand Down
3 changes: 1 addition & 2 deletions package/system/zram-swap/Makefile
Expand Up @@ -8,8 +8,7 @@
include $(TOPDIR)/rules.mk

PKG_NAME:=zram-swap
PKG_VERSION:=1.1
PKG_RELEASE:=4
PKG_RELEASE:=5

PKG_BUILD_DIR := $(BUILD_DIR)/$(PKG_NAME)

Expand Down

0 comments on commit 9c170cb

Please sign in to comment.