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 3F23A1396D1 for ; Tue, 12 Sep 2017 16:37:25 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 927511FC172; Tue, 12 Sep 2017 16:37:24 +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 63C741FC172 for ; Tue, 12 Sep 2017 16:37:24 +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 2FA6F34169C for ; Tue, 12 Sep 2017 16:37:23 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id CBBEC907D for ; Tue, 12 Sep 2017 16:37:21 +0000 (UTC) From: "Ulrich Müller" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Müller" Message-ID: <1505234158.6ebc5bb7e23966afaf46e9a9a568ba131ce6a019.ulm@gentoo> Subject: [gentoo-commits] repo/gentoo:eapi7-ver commit in: eclass/ X-VCS-Repository: repo/gentoo X-VCS-Files: eclass/eapi7-ver.eclass X-VCS-Directories: eclass/ X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Müller X-VCS-Revision: 6ebc5bb7e23966afaf46e9a9a568ba131ce6a019 X-VCS-Branch: eapi7-ver Date: Tue, 12 Sep 2017 16:37:21 +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: c28872f6-58ca-498a-90bc-60fc633bb798 X-Archives-Hash: 44edd9a3d077b5c2990c15ecbd1b26cb commit: 6ebc5bb7e23966afaf46e9a9a568ba131ce6a019 Author: Ulrich Müller gentoo org> AuthorDate: Tue Sep 12 09:31:16 2017 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Tue Sep 12 16:35:58 2017 +0000 URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=6ebc5bb7 eapi7-ver.eclass: Fix eclass documentation. - Reorder function tags in order not to confuse eclass-to-manpage.awk. - @ROFF tags for subheadings, since ==== underlines won't be properly rendered. - Two spaces after full stops to make nroff happy. eclass/eapi7-ver.eclass | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/eclass/eapi7-ver.eclass b/eclass/eapi7-ver.eclass index 5e8479dfdcd..1e8e3c5e55b 100644 --- a/eclass/eapi7-ver.eclass +++ b/eclass/eapi7-ver.eclass @@ -10,7 +10,7 @@ # @BLURB: Testing implementation of EAPI 7 version manipulators # @DESCRIPTION: # A stand-alone implementation of the version manipulation functions -# aimed for EAPI 7. Intended to be used for wider testing of +# aimed for EAPI 7. Intended to be used for wider testing of # the proposed functions and to allow ebuilds to switch to the new # model early, with minimal change needed for actual EAPI 7. # @@ -18,28 +18,30 @@ # # Note: version comparison function is not included currently. # +# @ROFF .SS # Version strings -# =============== +# # The functions support arbitrary version strings consisting of version # components interspersed with (possibly empty) version separators. # # A version component can either consist purely of digits ([0-9]+) -# or purely of uppercase and lowercase letters ([A-Za-z]+). A version +# or purely of uppercase and lowercase letters ([A-Za-z]+). A version # separator is either a string of any other characters ([^A-Za-z0-9]+), # or it occurs at the transition between a sequence of letters # and a sequence of digits, or vice versa. In the latter case, # the version separator is an empty string. # # The version is processed left-to-right, and each successive component -# is assigned numbers starting with 1. The components are either split +# is assigned numbers starting with 1. The components are either split # on version separators or on boundaries between digits and letters # (in which case the separator between the components is empty). # Version separators are assigned numbers starting with 1 for -# the separator between 1st and 2nd components. As a special case, +# the separator between 1st and 2nd components. As a special case, # if the version string starts with a separator, it is assigned index 0. # # Examples: # +# @CODE # 1.2b-alpha4 -> 1 . 2 '' b - alpha '' 4 # c s c s c s c s c # 1 1 2 2 3 3 4 4 5 @@ -47,12 +49,14 @@ # .11. -> . 11 . # s c s # 0 1 1 +# @CODE # +# @ROFF .SS # Ranges -# ====== +# # A range can be specified as 'm' for m-th version component, 'm-' # for all components starting with m-th or 'm-n' for components starting -# at m-th and ending at n-th (inclusive). If the range spans outside +# at m-th and ending at n-th (inclusive). If the range spans outside # the version string, it is truncated silently. case ${EAPI:-0} in @@ -65,11 +69,11 @@ case ${EAPI:-0} in esac # @FUNCTION: _ver_parse_range -# @INTERNAL # @USAGE: +# @INTERNAL # @DESCRIPTION: # Parse the range string , setting 'start' and 'end' variables -# to the appropriate bounds. and specify the appropriate +# to the appropriate bounds. and specify the appropriate # lower and upper bound for the range; the user-specified value is # truncated to this range. _ver_parse_range() { @@ -90,8 +94,8 @@ _ver_parse_range() { } # @FUNCTION: _ver_split -# @INTERNAL # @USAGE: +# @INTERNAL # @DESCRIPTION: # Split the version string into separator-component array. # Sets 'comp' to an array of the form: ( s_0 c_1 s_1 c_2 s_2 c_3... ) @@ -145,8 +149,8 @@ ver_cut() { # @USAGE: [ ...] [] # @DESCRIPTION: # Print the version string after substituting the specified version -# separators at with (string). Multiple ' ' -# pairs can be specified. Processes if specified, +# separators at with (string). Multiple ' ' +# pairs can be specified. Processes if specified, # ${PV} otherwise. # # For the syntax of versions and ranges, please see the eclass @@ -176,8 +180,8 @@ ver_rs() { # @FUNCTION: ver_test # @USAGE: [] # @DESCRIPTION: -# Check if the relation is true. If is not specified, -# default to ${PVR}. can be -gt, -ge, -eq, -ne, -le, -lt. +# Check if the relation is true. If is not specified, +# default to ${PVR}. can be -gt, -ge, -eq, -ne, -le, -lt. # Both versions must conform to the PMS version syntax (with optional # revision parts), and the comparison is performed according to # the algorithm specified in the PMS.