janware/jw-pkg
Watch
1
Code Pull requests Activity Actions

Compare commits

base: janware:6d60df44977f747630436e65e1f282f54fd7db3b
Branches Tags
janware:master
janware:released
..
compare: janware:01a0c4064777adbad29d2f950e65a3394d812680
Branches Tags
janware:master
janware:released
Author SHA1 Message Date
Jan Lindemann
01a0c40647
 		lib.version: Add API docstrings
Some checks failed
CI / Packaging - Kali Linux (pull_request) Failing after 2m22s
Details
CI / Packaging - OpenSUSE Tumbleweed (pull_request) Failing after 2m16s
Details
CI / Packaging test (pull_request) Failing after 0s
Details 
The lib.version module carries no documentation: the Syntax, Component and
Boundary types, the Version and Dependency classes and their public methods
are bare, and the compatibility tiers the next_* stepping methods implement
are not documented anywhere.

Add docstrings: a line each for the base.py types, the compatibility
tier table in the Version class, and a short description for every
public method, with the three next_* methods citing the tier each one
steps to.

Assisted-by: unsloth/Qwen3.8-27B-GGUF:Q4_K_M with pi.dev v0.84.2
Signed-off-by: Jan Lindemann <jan@janware.com>
 2026-09-09 15:22:19 +02:00
3 changed files with 18 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

14
make/pkg-dist.mk
View file

@ -78,13 +78,13 @@ ifeq ($(CREATE_DEVEL),true)
BINARY_PKG += $(DIST_PCKG_DIR)/$(PKG_DEVEL_X86) BINARY_PKG += $(DIST_PCKG_DIR)/$(PKG_DEVEL_X86)
endif endif
PKG_REQUIRES_BUILD += $(call proj_query, pkg-requires $(PROJ_QUERY_PKG_REQUIRES_EXTRA_ARGS) build $(PROJECT)) PKG_REQUIRES_BUILD += $(call proj_query, pkg-requires --dont-expand-version-macros $(PROJ_QUERY_PKG_REQUIRES_EXTRA_ARGS) build $(PROJECT))
PKG_REQUIRES_RUN += $(call proj_query, pkg-requires $(PROJ_QUERY_PKG_REQUIRES_EXTRA_ARGS) run $(PROJECT)) PKG_REQUIRES_RUN += $(call proj_query, pkg-requires --dont-expand-version-macros $(PROJ_QUERY_PKG_REQUIRES_EXTRA_ARGS) run $(PROJECT))
PKG_REQUIRES_DEVEL += $(call proj_query, pkg-requires $(PROJ_QUERY_PKG_REQUIRES_EXTRA_ARGS) devel $(PROJECT)) PKG_REQUIRES_DEVEL += $(call proj_query, pkg-requires --dont-expand-version-macros $(PROJ_QUERY_PKG_REQUIRES_EXTRA_ARGS) devel $(PROJECT))
PKG_CONFLICTS_RUN += $(call proj_query, pkg-conflicts $(PROJ_QUERY_PKG_CONFLICTS_EXTRA_ARGS) run $(PROJECT)) PKG_CONFLICTS_RUN += $(call proj_query, pkg-conflicts --dont-expand-version-macros $(PROJ_QUERY_PKG_CONFLICTS_EXTRA_ARGS) run $(PROJECT))
PKG_CONFLICTS_DEVEL += $(call proj_query, pkg-conflicts $(PROJ_QUERY_PKG_CONFLICTS_EXTRA_ARGS) devel $(PROJECT)) PKG_CONFLICTS_DEVEL += $(call proj_query, pkg-conflicts --dont-expand-version-macros $(PROJ_QUERY_PKG_CONFLICTS_EXTRA_ARGS) devel $(PROJECT))
PKG_PROVIDES_RUN += $(call proj_query, pkg-provides $(PROJ_QUERY_PKG_PROVIDES_EXTRA_ARGS) run $(PROJECT)) PKG_PROVIDES_RUN += $(call proj_query, pkg-provides --dont-expand-version-macros $(PROJ_QUERY_PKG_PROVIDES_EXTRA_ARGS) run $(PROJECT))
PKG_PROVIDES_DEVEL += $(call proj_query, pkg-provides $(PROJ_QUERY_PKG_PROVIDES_EXTRA_ARGS) devel $(PROJECT)) PKG_PROVIDES_DEVEL += $(call proj_query, pkg-provides --dont-expand-version-macros $(PROJ_QUERY_PKG_PROVIDES_EXTRA_ARGS) devel $(PROJECT))
PKG_UPLOAD_OS_NAME = $(shell echo $(OS_NAME_VERSION) | sed 's/-.*//') PKG_UPLOAD_OS_NAME = $(shell echo $(OS_NAME_VERSION) | sed 's/-.*//')
PKG_UPLOAD_OS_VERSION = $(shell echo $(OS_NAME_VERSION) | sed 's/[^-]\+-//') PKG_UPLOAD_OS_VERSION = $(shell echo $(OS_NAME_VERSION) | sed 's/[^-]\+-//')

16
scripts/pkg.sh
View file

@ -438,12 +438,16 @@ build_pkg()
local tar_archive_orig=$src_base.orig.tar.bz2 local tar_archive_orig=$src_base.orig.tar.bz2
local distribution=`get_os` local distribution=`get_os`
local rpm_requires_run="$PKG_REQUIRES_RUN" expand_version_macros() {
local rpm_requires_devel="$PKG_REQUIRES_DEVEL" echo "$@" | sed "s/__NEXT_VERSION__/$version/g; s/VERSION-REVISION/$version/g; s/VERSION/$version/g"
local rpm_conflicts_run="$PKG_CONFLICTS_RUN" }
local rpm_conflicts_devel="$PKG_CONFLICTS_DEVEL"
local rpm_provides_run="$PKG_PROVIDES_RUN" local rpm_requires_run=`expand_version_macros $PKG_REQUIRES_RUN`
local rpm_provides_devel="$PKG_PROVIDES_DEVEL" local rpm_requires_devel=`expand_version_macros $PKG_REQUIRES_DEVEL`
local rpm_conflicts_run=`expand_version_macros $PKG_CONFLICTS_RUN`
local rpm_conflicts_devel=`expand_version_macros $PKG_CONFLICTS_DEVEL`
local rpm_provides_run=`expand_version_macros $PKG_PROVIDES_RUN`
local rpm_provides_devel=`expand_version_macros $PKG_PROVIDES_DEVEL`
# --- create source directory tree # --- create source directory tree
create_empty_dir $src_tree "Source files compilation directory" create_empty_dir $src_tree "Source files compilation directory"

2
src/python/jw/pkg/lib/version/base.py
View file

@ -29,8 +29,8 @@ class Boundary(NamedTuple): # export
op: str op: str
version: Version version: Version
"""Syntax-aware formatted version comparion operator"""
"""Syntax-aware formatted version comparion operator"""
def format_op(self, syntax: Syntax) -> str: def format_op(self, syntax: Syntax) -> str:
if syntax is Syntax.DEBIAN: if syntax is Syntax.DEBIAN:
match self.op: match self.op: