From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) by finch.gentoo.org (Postfix) with ESMTP id 1BE4E1381F3 for ; Fri, 23 Aug 2013 13:52:25 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 1A2EDE0C31; Fri, 23 Aug 2013 13:52:22 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 8BAB4E0C31 for ; Fri, 23 Aug 2013 13:52:06 +0000 (UTC) Received: from hornbill.gentoo.org (hornbill.gentoo.org [94.100.119.163]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id DFC2833ECCE for ; Fri, 23 Aug 2013 13:52:04 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) by hornbill.gentoo.org (Postfix) with ESMTP id 18515E5474 for ; Fri, 23 Aug 2013 13:52:02 +0000 (UTC) From: "André Erdmann" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "André Erdmann" Message-ID: <1377264761.56d8c5f526e4139ac4f1207bbf23ac8b58101ac6.dywi@gentoo> Subject: [gentoo-commits] proj/R_overlay:master commit in: doc/rst/ X-VCS-Repository: proj/R_overlay X-VCS-Files: doc/rst/usage.rst X-VCS-Directories: doc/rst/ X-VCS-Committer: dywi X-VCS-Committer-Name: André Erdmann X-VCS-Revision: 56d8c5f526e4139ac4f1207bbf23ac8b58101ac6 X-VCS-Branch: master Date: Fri, 23 Aug 2013 13:52:02 +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: 36764386-4304-4b47-802a-78e8ed2fdf2d X-Archives-Hash: ed93240d2e4a6dbe40dda5a56838b816 commit: 56d8c5f526e4139ac4f1207bbf23ac8b58101ac6 Author: André Erdmann mailerd de> AuthorDate: Fri Aug 23 13:32:41 2013 +0000 Commit: André Erdmann mailerd de> CommitDate: Fri Aug 23 13:32:41 2013 +0000 URL: http://git.overlays.gentoo.org/gitweb/?p=proj/R_overlay.git;a=commit;h=56d8c5f5 doc/rst, package rules: 'add' action --- doc/rst/usage.rst | 120 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 67 insertions(+), 53 deletions(-) diff --git a/doc/rst/usage.rst b/doc/rst/usage.rst index 991a4b9..1379aad 100644 --- a/doc/rst/usage.rst +++ b/doc/rst/usage.rst @@ -1833,60 +1833,74 @@ control *where*) and the number of values they accept: .. table:: action keywords - +----------------+------------------+-------------+------------------------+ - | action keyword | affects | # of values | description | - +================+==================+=============+========================+ - | ignore | | | ignore package, | - +----------------+ overlay creation | none | do not try to create | - | do-not-process | | | an ebuild for it | - +----------------+------------------+-------------+------------------------+ - | keywords | ebuild variables | >= 1 | set per-package | - | | | | ``KEYWORDS`` | - +----------------+------------------+-------------+------------------------+ - | trace | package rules | none | mark a package as | - | | | | modified | - | | +-------------+------------------------+ - | | | 1 | add the stored string | - | | | | to a package's | - | | | | *modified* variable | - | | | | whenever this action | - | | | | is applied | - +----------------+------------------+-------------+------------------------+ - | set | package | 2 | set package | - +----------------+ metadata, +-------------+ information | - | set_ | overlay creaton | 1 | | - +----------------+------------------+-------------+------------------------+ - | rename | package | 2 | modify package | - +----------------+ metadata, +-------------+ information with | - | rename_ | overlay creation | 1 | sed-like | - | | | | *s/expr/repl/* | - | | | | statements | - +----------------+------------------+-------------+------------------------+ - | null | *n/a* | none | does nothing | - +----------------+ | | (can be used for | - | pass | | | readability) | - +----------------+------------------+-------------+------------------------+ - -The two-arg form of the set/rename keywords expect a as first and + +----------------+-------------------+-------------+------------------------+ + | action keyword | affects | # of values | description | + +================+===================+=============+========================+ + | ignore | | | ignore package, | + +----------------+ overlay creation | none | do not try to create | + | do-not-process | | | an ebuild for it | + +----------------+-------------------+-------------+------------------------+ + | keywords | ebuild variables | >= 1 | set per-package | + | | | | ``KEYWORDS`` | + +----------------+-------------------+-------------+------------------------+ + | trace | package rules | none | mark a package as | + | | | | modified | + | | +-------------+------------------------+ + | | | 1 | add the stored string | + | | | | to a package's | + | | | | *modified* variable | + | | | | whenever this action | + | | | | is applied | + +----------------+-------------------+-------------+------------------------+ + | set | package metadata, | 2 | set package | + +----------------+ overlay creation, +-------------+ information | + | set_ | ebuild creation | 1 | | + +----------------+ +-------------+------------------------+ + | rename | | 2 | modify package | + +----------------+ +-------------+ information with | + | rename_ | | 1 | sed-like | + | | | | *s/expr/repl/* | + | | | | statements | + +----------------+ +-------------+------------------------+ + | add | | 2 | similar to *set*, but | + +----------------+ +-------------+ can be applied | + | add_ | | 1 | multiple times without | + | | | | overwriting existing | + | | | | information | + +----------------+-------------------+-------------+------------------------+ + | null | *n/a* | none | does nothing | + +----------------+ | | (can be used for | + | pass | | | improving readability) | + +----------------+-------------------+-------------+------------------------+ + +The two-arg form of the set/rename/add keywords expect a as first and a value / sed expression as second arg. The one-arg form expects the latter -one only. The "/" delimitier in the sed expression can be any character. +one only. keys are case-insensitive. The "/" delimitier in the sed expression +can be any other character. The following *info keys* can be set and/or modified: -.. table:: info keys for set/rename - - +--------------+---------------------+-------------------------------------+ - | info key | supports set/rename | description | - +==============+=====================+=====================================+ - | name | yes / yes | rename the ebuild | - +--------------+---------------------+-------------------------------------+ - | category | yes / yes | set or rename (based on the | - | | (*repo_name*) | repository's name) the package's | - | | | category | - +--------------+---------------------+-------------------------------------+ - | destfile | yes / yes | rename ebuild destfile by using the | - | | | '->' operator in ``${SRC_URI}`` | - +--------------+---------------------+-------------------------------------+ +.. table:: info keys for set/rename/add + + +--------------+-------------------------+-------------------------------------+ + | info key | supports set/rename/add | description | + +==============+=========================+=====================================+ + | name | yes / yes / no | rename the ebuild | + +--------------+-------------------------+-------------------------------------+ + | category | yes / yes (*repo name*) | set or rename (based on the | + | | / no | repository's name) the package's | + | | | category | + +--------------+-------------------------+-------------------------------------+ + | destfile | yes / yes / no | rename ebuild destfile by using the | + | | | '->' operator in ``${SRC_URI}`` | + +--------------+-------------------------+-------------------------------------+ + | DEPEND | no / no / **yes** | add additional dependencies to | + +--------------+ | *DEPEND/RDEPEND/RSUGGESTS* | + | RDEPEND | | | + +--------------+ | The value has to be a string | + | RSUGGESTS | | accepted by the package manager, | + | | | e.g. a *DEPEND Atom*. | + +--------------+-------------------------+-------------------------------------+ The *set* action also supports variable substitution by means of python @@ -1930,9 +1944,9 @@ The following *info keys* can be accessed: .. Note:: - Applying the same (non-incremental) ebuild variable, set or rename action - more than once is possible, but only the last one will have an effect - on ebuild creation. + Applying the same ebuild variable, set or rename action more than once + is possible, but only the last one will have an effect on ebuild creation. + add actions are cumulative by definition. Extended Action Block Syntax