Skip to main content

Module pkgname

pkgsrc

Module pkgname 

Source
Expand description

Package name parsing into base, version, and revision components.

In pkgsrc, every package has a PKGNAME that uniquely identifies a specific version of a package.

PKGNAME = PKGBASE-PKGVERSION
PKGVERSION = VERSION[nbPKGREVISION]

For example, mktool-1.4.2nb3 breaks down as:

  • PKGBASE: mktool - the package name
  • PKGVERSION: 1.4.2nb3 - the full version string
  • VERSION: 1.4.2 - the upstream version
  • PKGREVISION: 3 - the pkgsrc-specific revision

The PKGBASE and PKGVERSION are separated by the last hyphen (-) in the string. The PKGREVISION suffix (nb followed by a number) indicates pkgsrc-specific changes that do not correspond to an upstream release.

§Examples

use pkgsrc::PkgName;

let pkg = PkgName::new("nginx-1.25.3nb2");
assert_eq!(pkg.pkgbase(), "nginx");
assert_eq!(pkg.pkgversion(), "1.25.3nb2");
assert_eq!(pkg.pkgrevision(), Some(2));

// Package with hyphenated name
let pkg = PkgName::new("p5-libwww-6.77");
assert_eq!(pkg.pkgbase(), "p5-libwww");
assert_eq!(pkg.pkgversion(), "6.77");
assert_eq!(pkg.pkgrevision(), None);

// Package without revision
let pkg = PkgName::new("curl-8.5.0");
assert_eq!(pkg.pkgbase(), "curl");
assert_eq!(pkg.pkgversion(), "8.5.0");
assert_eq!(pkg.pkgrevision(), None);

§PKGREVISION

The PKGREVISION is incremented by pkgsrc maintainers when:

  • A dependency is updated and the package needs rebuilding
  • pkgsrc-specific patches are modified
  • Build or packaging changes are made

For version comparison, 1.0nb1 > 1.0 > 1.0rc1. See the dewey module for details on version comparison rules.

Structs§

PkgName
Parse a PKGNAME into its constituent parts.

Functions§

pkgbase
Return the PKGBASE portion of a package name, i.e. everything before the final -, or the full input if no - is present.
pkgrevision
Return the PKGREVISION parsed from a package version, i.e. the integer following the final nb.
pkgversion
Return the PKGVERSION portion of a package name, i.e. everything after the final -, or the empty string if no - is present.
pkgversion_norev
Return the PKGVERSION_NOREV portion of a package version, i.e. the version with any trailing nb<n> revision marker stripped.