From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id D020C1396D0 for ; Wed, 13 Sep 2017 13:47:30 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 2E35DE0C7C; Wed, 13 Sep 2017 13:47:30 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id F3D8AE0C7C for ; Wed, 13 Sep 2017 13:47:29 +0000 (UTC) Received: from oystercatcher.gentoo.org (unknown [IPv6:2a01:4f8:202:4333:225:90ff:fed9:fc84]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id E6C4233D3CE for ; Wed, 13 Sep 2017 13:47:28 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id A5A939078 for ; Wed, 13 Sep 2017 13:47:27 +0000 (UTC) From: "Michael Palimaka" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Michael Palimaka" Message-ID: <1505310439.2c1d7fc8177c64a83d0d92956f5699bb3537c555.kensington@gentoo> Subject: [gentoo-commits] proj/kde:master commit in: eclass/ X-VCS-Repository: proj/kde X-VCS-Files: eclass/kde5-functions.eclass X-VCS-Directories: eclass/ X-VCS-Committer: kensington X-VCS-Committer-Name: Michael Palimaka X-VCS-Revision: 2c1d7fc8177c64a83d0d92956f5699bb3537c555 X-VCS-Branch: master Date: Wed, 13 Sep 2017 13:47:27 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Archives-Salt: 64854da3-c441-4c7b-bb79-e05d18d8a69d X-Archives-Hash: 48af13eec5ea981dff9a5bd9796f9d39 commit: 2c1d7fc8177c64a83d0d92956f5699bb3537c555 Author: Michael Palimaka gentoo org> AuthorDate: Wed Sep 13 13:47:13 2017 +0000 Commit: Michael Palimaka gentoo org> CommitDate: Wed Sep 13 13:47:19 2017 +0000 URL: https://gitweb.gentoo.org/proj/kde.git/commit/?id=2c1d7fc8 kde5-functions.eclass: improve documentation eclass/kde5-functions.eclass | 44 +++++++++++++++++++++++++++----------------- 1 file changed, 27 insertions(+), 17 deletions(-) diff --git a/eclass/kde5-functions.eclass b/eclass/kde5-functions.eclass index 120471344d..95debee53e 100644 --- a/eclass/kde5-functions.eclass +++ b/eclass/kde5-functions.eclass @@ -4,10 +4,12 @@ # @ECLASS: kde5-functions.eclass # @MAINTAINER: # kde@gentoo.org -# @BLURB: Common ebuild functions for KDE 5 packages +# @BLURB: Common ebuild functions for KDE 5-related packages. # @DESCRIPTION: -# This eclass contains all functions shared by the different eclasses, -# for KDE 5 ebuilds. +# This eclass contains functions shared by the other KDE 5 eclasses and forms +# part of their public API. +# +# This elass should (almost) never be inherited directly by an ebuild. if [[ -z ${_KDE5_FUNCTIONS_ECLASS} ]]; then _KDE5_FUNCTIONS_ECLASS=1 @@ -22,7 +24,10 @@ case ${EAPI} in *) die "EAPI=${EAPI:-0} is not supported" ;; esac -# determine the build type +# @ECLASS-VARIABLE: KDE_BUILD_TYPE +# @DESCRIPTION: +# If PV matches "*9999*", this is automatically set to "live". +# Otherwise, this is automatically set to "release". if [[ ${PV} = *9999* ]]; then KDE_BUILD_TYPE="live" else @@ -43,28 +48,29 @@ esac # @ECLASS-VARIABLE: QT_MINIMAL # @DESCRIPTION: -# Minimal Qt version to require for the package. +# Minimum version of Qt to require. This affects add_qt_dep. : ${QT_MINIMAL:=5.7.1} # @ECLASS-VARIABLE: FRAMEWORKS_MINIMAL # @DESCRIPTION: -# Minimal Frameworks version to require for the package. +# Minimum version of Frameworks to require. This affects add_frameworks_dep. : ${FRAMEWORKS_MINIMAL:=5.37.0} # @ECLASS-VARIABLE: PLASMA_MINIMAL # @DESCRIPTION: -# Minimal Plasma version to require for the package. +# Minimum version of Plasma to remove. This affects add_plasma_dep. : ${PLASMA_MINIMAL:=5.10.4} # @ECLASS-VARIABLE: KDE_APPS_MINIMAL # @DESCRIPTION: -# Minimal KDE Applications version to require for the package. +# Minimum version of KDE Applications to require. This affects add_kdeapps_dep. : ${KDE_APPS_MINIMAL:=14.12.0} # @ECLASS-VARIABLE: KDE_GCC_MINIMAL # @DEFAULT_UNSET # @DESCRIPTION: -# Minimal GCC version to require for the package. +# Minimum version of active GCC to require. This is checked in kde5.eclass in +# kde5_pkg_pretend and kde5_pkg_setup. # @ECLASS-VARIABLE: KDEBASE # @DESCRIPTION: @@ -78,7 +84,8 @@ debug-print "${ECLASS}: ${KDEBASE} ebuild recognized" # @ECLASS-VARIABLE: KDE_SCM # @DESCRIPTION: -# SCM to use if this is a live ebuild. +# SCM to use if KDE_BUILD_TYPE is determined to be "live". +# Currently, only git is supported. : ${KDE_SCM:=git} case ${KDE_SCM} in @@ -147,7 +154,7 @@ _add_category_dep() { } # @FUNCTION: add_frameworks_dep -# @USAGE: [USE flags] [minimum version] +# @USAGE: [USE flags] [minimum version] [slot + operator] # @DESCRIPTION: # Create proper dependency for kde-frameworks/ dependencies. # This takes 1 to 4 arguments. The first being the package name, the optional @@ -179,7 +186,7 @@ add_frameworks_dep() { } # @FUNCTION: add_plasma_dep -# @USAGE: [USE flags] [minimum version] +# @USAGE: [USE flags] [minimum version] [slot + operator] # @DESCRIPTION: # Create proper dependency for kde-plasma/ dependencies. # This takes 1 to 4 arguments. The first being the package name, the optional @@ -211,7 +218,7 @@ add_plasma_dep() { } # @FUNCTION: add_kdeapps_dep -# @USAGE: [USE flags] [minimum version] +# @USAGE: [USE flags] [minimum version] [slot + operator] # @DESCRIPTION: # Create proper dependency for kde-apps/ dependencies. # This takes 1 to 4 arguments. The first being the package name, the optional @@ -243,7 +250,7 @@ add_kdeapps_dep() { } # @FUNCTION: add_qt_dep -# @USAGE: [USE flags] [minimum version] +# @USAGE: [USE flags] [minimum version] [slot + operator] # @DESCRIPTION: # Create proper dependency for dev-qt/ dependencies. # This takes 1 to 4 arguments. The first being the package name, the optional @@ -277,10 +284,13 @@ add_qt_dep() { _add_category_dep dev-qt "${1}" "${2}" "${version}" "${slot}" } -# @FUNCTION: get_kde_version +# @FUNCTION: get_kde_version [version] # @DESCRIPTION: -# Translates an ebuild version into a major.minor KDE SC -# release version. If no version is specified, ${PV} is used. +# Translates an ebuild version into a major.minor KDE release version, taking +# into account KDE's prerelease versioning scheme. +# For example, get_kde_version 17.07.80 will return "17.08". +# If the version equals 9999, "live" is returned. +# If no version is specified, ${PV} is used. get_kde_version() { local ver=${1:-${PV}} local major=$(get_major_version ${ver})