From: "André Erdmann" <dywi@mailerd.de>
To: gentoo-commits@lists.gentoo.org
Subject: [gentoo-commits] proj/R_overlay:master commit in: doc/html/
Date: Tue, 18 Jun 2013 14:12:56 +0000 (UTC) [thread overview]
Message-ID: <1371560085.7bb0058e0639e2829eae14dd0bef98e230ef60dc.dywi@gentoo> (raw)
Message-ID: <20130618141256.gs9J8cRHn8DfXF9i7ZiMA9iaCuEVLZVniKb_P6HC708@z> (raw)
commit: 7bb0058e0639e2829eae14dd0bef98e230ef60dc
Author: André Erdmann <dywi <AT> mailerd <DOT> de>
AuthorDate: Tue Jun 18 12:54:45 2013 +0000
Commit: André Erdmann <dywi <AT> mailerd <DOT> de>
CommitDate: Tue Jun 18 12:54:45 2013 +0000
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/R_overlay.git;a=commit;h=7bb0058e
doc/html: r_suggests USE_EXPAND variable
---
doc/html/usage.html | 309 +++++++++++++++++++++++++++++++++++-----------------
1 file changed, 211 insertions(+), 98 deletions(-)
diff --git a/doc/html/usage.html b/doc/html/usage.html
index 5c4863b..9206894 100644
--- a/doc/html/usage.html
+++ b/doc/html/usage.html
@@ -329,116 +329,120 @@ ul.auto-toc {
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="auto-toc simple">
-<li><a class="reference internal" href="#introduction" id="id4">1 Introduction</a></li>
-<li><a class="reference internal" href="#installation" id="id5">2 Installation</a><ul class="auto-toc">
-<li><a class="reference internal" href="#prerequisites" id="id6">2.1 Prerequisites</a></li>
-<li><a class="reference internal" href="#via-emerge-gentoo" id="id7">2.2 via emerge (Gentoo)</a></li>
-<li><a class="reference internal" href="#manual-installation" id="id8">2.3 Manual Installation</a></li>
-<li><a class="reference internal" href="#using-roverlay-without-installation" id="id9">2.4 Using <em>roverlay</em> without installation</a></li>
+<li><a class="reference internal" href="#introduction" id="id5">1 Introduction</a></li>
+<li><a class="reference internal" href="#installation" id="id6">2 Installation</a><ul class="auto-toc">
+<li><a class="reference internal" href="#prerequisites" id="id7">2.1 Prerequisites</a></li>
+<li><a class="reference internal" href="#via-emerge-gentoo" id="id8">2.2 via emerge (Gentoo)</a></li>
+<li><a class="reference internal" href="#manual-installation" id="id9">2.3 Manual Installation</a></li>
+<li><a class="reference internal" href="#using-roverlay-without-installation" id="id10">2.4 Using <em>roverlay</em> without installation</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#running-roverlay" id="id10">3 Running Roverlay</a><ul class="auto-toc">
-<li><a class="reference internal" href="#required-configuration-steps" id="id11">3.1 Required configuration steps</a><ul class="auto-toc">
-<li><a class="reference internal" href="#extended-configuration-where-to-go-from-here" id="id12">3.1.1 Extended Configuration / Where to go from here?</a></li>
+<li><a class="reference internal" href="#running-roverlay" id="id11">3 Running Roverlay</a><ul class="auto-toc">
+<li><a class="reference internal" href="#required-configuration-steps" id="id12">3.1 Required configuration steps</a><ul class="auto-toc">
+<li><a class="reference internal" href="#extended-configuration-where-to-go-from-here" id="id13">3.1.1 Extended Configuration / Where to go from here?</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#running-it" id="id13">3.2 Running it</a></li>
-<li><a class="reference internal" href="#providing-a-package-mirror" id="id14">3.3 Providing a package mirror</a></li>
+<li><a class="reference internal" href="#running-it" id="id14">3.2 Running it</a></li>
+<li><a class="reference internal" href="#providing-a-package-mirror" id="id15">3.3 Providing a package mirror</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#basic-implementation-overview" id="id15">4 Basic Implementation Overview</a><ul class="auto-toc">
-<li><a class="reference internal" href="#how-roverlay-works" id="id16">4.1 How <em>roverlay</em> works</a></li>
-<li><a class="reference internal" href="#expected-overlay-result-structure-of-the-generated-overlay" id="id17">4.2 Expected Overlay Result / Structure of the generated overlay</a><ul class="auto-toc">
-<li><a class="reference internal" href="#expected-ebuild-result" id="id18">4.2.1 Expected Ebuild Result</a></li>
-<li><a class="reference internal" href="#expected-metadata-xml-result" id="id19">4.2.2 Expected <em>metadata.xml</em> Result</a></li>
+<li><a class="reference internal" href="#basic-implementation-overview" id="id16">4 Basic Implementation Overview</a><ul class="auto-toc">
+<li><a class="reference internal" href="#how-roverlay-works" id="id17">4.1 How <em>roverlay</em> works</a></li>
+<li><a class="reference internal" href="#expected-overlay-result-structure-of-the-generated-overlay" id="id18">4.2 Expected Overlay Result / Structure of the generated overlay</a><ul class="auto-toc">
+<li><a class="reference internal" href="#expected-ebuild-result" id="id19">4.2.1 Expected Ebuild Result</a></li>
+<li><a class="reference internal" href="#expected-metadata-xml-result" id="id20">4.2.2 Expected <em>metadata.xml</em> Result</a></li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference internal" href="#repositories-getting-packages" id="id20">5 Repositories / Getting Packages</a><ul class="auto-toc">
-<li><a class="reference internal" href="#a-word-about-repo-config-files" id="id21">5.1 A word about repo config files</a></li>
-<li><a class="reference internal" href="#rsync-repos" id="id22">5.2 Rsync repos</a></li>
-<li><a class="reference internal" href="#getting-packages-from-a-repository-that-supports-http-only" id="id23">5.3 Getting packages from a repository that supports http only</a></li>
-<li><a class="reference internal" href="#getting-packages-from-several-remotes-using-http-and-a-package-list" id="id24">5.4 Getting packages from several remotes using http and a package list</a></li>
-<li><a class="reference internal" href="#using-local-directories" id="id25">5.5 Using local directories</a></li>
+<li><a class="reference internal" href="#repositories-getting-packages" id="id21">5 Repositories / Getting Packages</a><ul class="auto-toc">
+<li><a class="reference internal" href="#a-word-about-repo-config-files" id="id22">5.1 A word about repo config files</a></li>
+<li><a class="reference internal" href="#rsync-repos" id="id23">5.2 Rsync repos</a></li>
+<li><a class="reference internal" href="#getting-packages-from-a-repository-that-supports-http-only" id="id24">5.3 Getting packages from a repository that supports http only</a></li>
+<li><a class="reference internal" href="#getting-packages-from-several-remotes-using-http-and-a-package-list" id="id25">5.4 Getting packages from several remotes using http and a package list</a></li>
+<li><a class="reference internal" href="#using-local-directories" id="id26">5.5 Using local directories</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#additions-directory" id="id26">6 Additions Directory</a><ul class="auto-toc">
-<li><a class="reference internal" href="#patching-ebuilds" id="id27">6.1 Patching ebuilds</a></li>
-<li><a class="reference internal" href="#importing-ebuilds" id="id28">6.2 Importing ebuilds</a></li>
+<li><a class="reference internal" href="#additions-directory" id="id27">6 Additions Directory</a><ul class="auto-toc">
+<li><a class="reference internal" href="#patching-ebuilds" id="id28">6.1 Patching ebuilds</a></li>
+<li><a class="reference internal" href="#importing-ebuilds" id="id29">6.2 Importing ebuilds</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#dependency-rules" id="id29">7 Dependency Rules</a><ul class="auto-toc">
-<li><a class="reference internal" href="#simple-dependency-rules" id="id30">7.1 Simple Dependency Rules</a><ul class="auto-toc">
-<li><a class="reference internal" href="#rule-variants" id="id31">7.1.1 Rule Variants</a></li>
-<li><a class="reference internal" href="#rule-types" id="id32">7.1.2 Rule types</a></li>
-<li><a class="reference internal" href="#rule-file-examples" id="id33">7.1.3 Rule File Examples</a></li>
-<li><a class="reference internal" href="#rule-file-syntax" id="id34">7.1.4 Rule File Syntax</a></li>
+<li><a class="reference internal" href="#dependency-rules" id="id30">7 Dependency Rules</a><ul class="auto-toc">
+<li><a class="reference internal" href="#simple-dependency-rules" id="id31">7.1 Simple Dependency Rules</a><ul class="auto-toc">
+<li><a class="reference internal" href="#rule-variants" id="id32">7.1.1 Rule Variants</a></li>
+<li><a class="reference internal" href="#rule-types" id="id33">7.1.2 Rule types</a></li>
+<li><a class="reference internal" href="#rule-file-examples" id="id34">7.1.3 Rule File Examples</a></li>
+<li><a class="reference internal" href="#rule-file-syntax" id="id35">7.1.4 Rule File Syntax</a></li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference internal" href="#package-rules" id="id35">8 Package Rules</a><ul class="auto-toc">
-<li><a class="reference internal" href="#package-rule-file-syntax" id="id36">8.1 Package Rule File Syntax</a><ul class="auto-toc">
-<li><a class="reference internal" href="#match-blocks" id="id37">8.1.1 Match Blocks</a><ul class="auto-toc">
-<li><a class="reference internal" href="#extended-match-block-syntax" id="id38">8.1.1.1 Extended Match Block Syntax</a></li>
+<li><a class="reference internal" href="#package-rules" id="id36">8 Package Rules</a><ul class="auto-toc">
+<li><a class="reference internal" href="#package-rule-file-syntax" id="id37">8.1 Package Rule File Syntax</a><ul class="auto-toc">
+<li><a class="reference internal" href="#match-blocks" id="id38">8.1.1 Match Blocks</a><ul class="auto-toc">
+<li><a class="reference internal" href="#extended-match-block-syntax" id="id39">8.1.1.1 Extended Match Block Syntax</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#action-blocks" id="id39">8.1.2 Action Blocks</a><ul class="auto-toc">
-<li><a class="reference internal" href="#extended-action-block-syntax" id="id40">8.1.2.1 Extended Action Block Syntax</a></li>
+<li><a class="reference internal" href="#action-blocks" id="id40">8.1.2 Action Blocks</a><ul class="auto-toc">
+<li><a class="reference internal" href="#extended-action-block-syntax" id="id41">8.1.2.1 Extended Action Block Syntax</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#package-rule-examples" id="id41">8.1.3 Package Rule Examples</a></li>
+<li><a class="reference internal" href="#package-rule-examples" id="id42">8.1.3 Package Rule Examples</a></li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference internal" href="#configuration-reference" id="id42">9 Configuration Reference</a><ul class="auto-toc">
-<li><a class="reference internal" href="#misc-options" id="id43">9.1 misc options</a></li>
-<li><a class="reference internal" href="#overlay-options" id="id44">9.2 overlay options</a></li>
-<li><a class="reference internal" href="#other-config-files" id="id45">9.3 other config files</a></li>
-<li><a class="reference internal" href="#logging" id="id46">9.4 logging</a><ul class="auto-toc">
-<li><a class="reference internal" href="#console-logging" id="id47">9.4.1 console logging</a></li>
-<li><a class="reference internal" href="#file-logging" id="id48">9.4.2 file logging</a></li>
+<li><a class="reference internal" href="#configuration-reference" id="id43">9 Configuration Reference</a><ul class="auto-toc">
+<li><a class="reference internal" href="#misc-options" id="id44">9.1 misc options</a></li>
+<li><a class="reference internal" href="#overlay-options" id="id45">9.2 overlay options</a></li>
+<li><a class="reference internal" href="#other-config-files" id="id46">9.3 other config files</a></li>
+<li><a class="reference internal" href="#logging" id="id47">9.4 logging</a><ul class="auto-toc">
+<li><a class="reference internal" href="#console-logging" id="id48">9.4.1 console logging</a></li>
+<li><a class="reference internal" href="#file-logging" id="id49">9.4.2 file logging</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#options-for-debugging-manual-dependency-rule-creation-and-testing" id="id49">9.5 options for debugging, manual dependency rule creation and testing</a></li>
+<li><a class="reference internal" href="#options-for-debugging-manual-dependency-rule-creation-and-testing" id="id50">9.5 options for debugging, manual dependency rule creation and testing</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#field-definition-config" id="id50">10 Field Definition Config</a><ul class="auto-toc">
-<li><a class="reference internal" href="#example-the-default-field-definition-file" id="id51">10.1 Example: The default field definition file</a></li>
+<li><a class="reference internal" href="#id3" id="id51">10 Other config files</a><ul class="auto-toc">
+<li><a class="reference internal" href="#use-expand-flag-rename-file" id="id52">10.1 USE_EXPAND flag rename file</a></li>
+<li><a class="reference internal" href="#field-definition-config" id="id53">10.2 Field Definition Config</a><ul class="auto-toc">
+<li><a class="reference internal" href="#example-the-default-field-definition-file" id="id54">10.2.1 Example: The default field definition file</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#dependency-resolution-console" id="id52">11 Dependency Resolution Console</a></li>
-<li><a class="reference internal" href="#implementation-overview" id="id53">12 Implementation Overview</a><ul class="auto-toc">
-<li><a class="reference internal" href="#packageinfo" id="id54">12.1 PackageInfo</a></li>
-<li><a class="reference internal" href="#repository-management" id="id55">12.2 Repository Management</a><ul class="auto-toc">
-<li><a class="reference internal" href="#repository" id="id56">12.2.1 Repository</a><ul class="auto-toc">
-<li><a class="reference internal" href="#adding-new-repository-types" id="id57">12.2.1.1 Adding new repository types</a></li>
</ul>
</li>
+<li><a class="reference internal" href="#dependency-resolution-console" id="id55">11 Dependency Resolution Console</a></li>
+<li><a class="reference internal" href="#implementation-overview" id="id56">12 Implementation Overview</a><ul class="auto-toc">
+<li><a class="reference internal" href="#packageinfo" id="id57">12.1 PackageInfo</a></li>
+<li><a class="reference internal" href="#repository-management" id="id58">12.2 Repository Management</a><ul class="auto-toc">
+<li><a class="reference internal" href="#repository" id="id59">12.2.1 Repository</a><ul class="auto-toc">
+<li><a class="reference internal" href="#adding-new-repository-types" id="id60">12.2.1.1 Adding new repository types</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#overlay" id="id58">12.3 Overlay</a><ul class="auto-toc">
-<li><a class="reference internal" href="#metadata-creation" id="id59">12.3.1 Metadata Creation</a></li>
-<li><a class="reference internal" href="#manifest-creation" id="id60">12.3.2 Manifest Creation</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#ebuild-creation" id="id61">12.4 Ebuild Creation</a><ul class="auto-toc">
-<li><a class="reference internal" href="#ebuild-variables" id="id62">12.4.1 Ebuild Variables</a></li>
+<li><a class="reference internal" href="#overlay" id="id61">12.3 Overlay</a><ul class="auto-toc">
+<li><a class="reference internal" href="#metadata-creation" id="id62">12.3.1 Metadata Creation</a></li>
+<li><a class="reference internal" href="#manifest-creation" id="id63">12.3.2 Manifest Creation</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#overlay-creation" id="id63">12.5 Overlay Creation</a></li>
-<li><a class="reference internal" href="#dependency-resolution" id="id64">12.6 Dependency Resolution</a><ul class="auto-toc">
-<li><a class="reference internal" href="#dependency-types" id="id65">12.6.1 Dependency types</a><ul class="auto-toc">
-<li><a class="reference internal" href="#description-file-dependency-fields" id="id66">12.6.1.1 DESCRIPTION file dependency fields</a></li>
+<li><a class="reference internal" href="#ebuild-creation" id="id64">12.4 Ebuild Creation</a><ul class="auto-toc">
+<li><a class="reference internal" href="#ebuild-variables" id="id65">12.4.1 Ebuild Variables</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#dependency-environments" id="id67">12.6.2 Dependency Environments</a></li>
-<li><a class="reference internal" href="#ebuildjob-channel" id="id68">12.6.3 EbuildJob Channel</a></li>
-<li><a class="reference internal" href="#dependency-rule-pools" id="id69">12.6.4 Dependency Rule Pools</a></li>
-<li><a class="reference internal" href="#dependency-resolver-modules" id="id70">12.6.5 Dependency Resolver Modules</a></li>
-<li><a class="reference internal" href="#dependency-resolver" id="id71">12.6.6 Dependency Resolver</a></li>
+<li><a class="reference internal" href="#overlay-creation" id="id66">12.5 Overlay Creation</a></li>
+<li><a class="reference internal" href="#dependency-resolution" id="id67">12.6 Dependency Resolution</a><ul class="auto-toc">
+<li><a class="reference internal" href="#dependency-types" id="id68">12.6.1 Dependency types</a><ul class="auto-toc">
+<li><a class="reference internal" href="#description-file-dependency-fields" id="id69">12.6.1.1 DESCRIPTION file dependency fields</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#dependency-environments" id="id70">12.6.2 Dependency Environments</a></li>
+<li><a class="reference internal" href="#ebuildjob-channel" id="id71">12.6.3 EbuildJob Channel</a></li>
+<li><a class="reference internal" href="#dependency-rule-pools" id="id72">12.6.4 Dependency Rule Pools</a></li>
+<li><a class="reference internal" href="#dependency-resolver-modules" id="id73">12.6.5 Dependency Resolver Modules</a></li>
+<li><a class="reference internal" href="#dependency-resolver" id="id74">12.6.6 Dependency Resolver</a></li>
</ul>
</li>
</ul>
@@ -702,6 +706,16 @@ This option is <strong>required</strong> and can be overridden on the command li
via <tt class="docutils literal"><span class="pre">--field-definition</span> <file></tt>.</p>
<p class="last">Example: FIELD_DEFINITION = ~/roverlay/config/description_fields.conf</p>
</dd>
+<dt>USE_EXPAND_DESC</dt>
+<dd><p class="first">A file that contains USE_EXPAND flag descriptions. This option is not
+required.</p>
+<p class="last">Example: USE_EXPAND_DESC = ~/roverlay/config/useflag/useflag_desc</p>
+</dd>
+<dt>USE_EXPAND_RENAME</dt>
+<dd><p class="first">The value of this option should point to a USE flag remap file which
+can be used to rename USE_EXPAND flags. This option is not required.</p>
+<p class="last">Example: USE_EXPAND_RENAME = ~/roverlay/config/useflag_rename</p>
+</dd>
<dt>OVERLAY_ECLASS</dt>
<dd><p class="first">This option lists eclass files that should be imported into the overlay
(into <em>OVERLAY_DIR</em>/eclass/) and inherited in all ebuilds.
@@ -751,7 +765,7 @@ they work.</dd>
<dd>See <a class="reference internal" href="#configuration-reference">Configuration Reference</a> for all main config options like log file
rotation and assistance for writing new <em>dependency rules</em>.</dd>
<dt>Field Definition</dt>
-<dd>Refer to <a class="reference internal" href="#id3">Field Definition</a> in case you want to change <em>how</em> R packages
+<dd>Refer to <a class="reference internal" href="#id4">Field Definition</a> in case you want to change <em>how</em> R packages
are being read, e.g. if you want the 'Depents' information field (obviously
a typo) to be understood as 'Depends'.</dd>
</dl>
@@ -954,6 +968,10 @@ and may decide to write <em>p</em>'s ebuild now (or later)</p>
</blockquote>
<ol class="arabic simple" start="6">
<li>write the overlay<ul>
+<li>write/update the profiles dir<ul>
+<li><em>roverlay</em> respects manual changes to USE_EXPAND description files</li>
+</ul>
+</li>
<li>write all ebuilds and apply patches to them
(supports threads on a per package basis)</li>
<li>write the <em>metadata.xml</em> files
@@ -983,6 +1001,8 @@ eclass file are used, the result should look like:</p>
<overlay root>/profiles/categories
<overlay root>/profiles/repo_name
<overlay root>/profiles/use.desc
+<overlay root>/profiles/desc
+<overlay root>/profiles/desc/r_suggests.desc
<overlay root>/sci-R/<many directories per R package>
<overlay root>/sci-R/seewave/
<overlay root>/sci-R/seewave/Manifest
@@ -996,19 +1016,22 @@ eclass file are used, the result should look like:</p>
<dt>Ebuild Template</dt>
<dd><pre class="code text first literal-block">
<ebuild header>
+
+EAPI=<EAPI>
+
inherit <eclass(es)>
DESCRIPTION="<the R package's description>"
SRC_URI="<src uri for the R package>"
-IUSE="${IUSE:-}
- R_suggests
+IUSE="${IUSE-}
+ r_suggests_<flag> r_suggests_<another flag> ...
"
-R_SUGGESTS="<R package suggestions>"
+R_SUGGESTS="r_suggests_<flag>? ( <optional dependency> ) ..."
DEPEND="<build time dependencies for the R package>"
-RDEPEND="${DEPEND:-}
+RDEPEND="${DEPEND-}
<runtime dependencies>
- R_suggests? ( ${R_SUGGESTS} )
+ ${R_SUGGESTS-}
"
_UNRESOLVED_PACKAGES=(<unresolvable, but optional dependencies>)
@@ -1017,6 +1040,9 @@ _UNRESOLVED_PACKAGES=(<unresolvable, but optional dependencies>)
<p>A really minimal ebuild would look like:</p>
<pre class="code text last literal-block">
<ebuild header>
+
+EAPI=<EAPI>
+
inherit <eclass(es)>
SRC_URI="<src uri for the R package>"
@@ -1026,7 +1052,7 @@ SRC_URI="<src uri for the R package>"
<dd><p class="first">The default ebuild header (which cannot be changed) automatically sets
the ebuild's copyright year to 1999-<em><current year></em>.</p>
<pre class="code sh last literal-block">
-<span class="comment"># Copyright 1999-2012 Gentoo Foundation
+<span class="comment"># Copyright 1999-2013 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: $
</span>
@@ -1036,11 +1062,13 @@ inherit R-packages
<span class="name variable">DESCRIPTION</span><span class="operator">=</span><span class="literal string double">"Time wave analysis and graphical representation"</span>
<span class="name variable">SRC_URI</span><span class="operator">=</span><span class="literal string double">"http://cran.r-project.org/src/contrib/seewave_1.6.4.tar.gz"</span>
-<span class="name variable">IUSE</span><span class="operator">=</span><span class="literal string double">"${IUSE:-}
- R_suggests
+<span class="name variable">IUSE</span><span class="operator">=</span><span class="literal string double">"${IUSE-}
+ r_suggests_sound
+ r_suggests_audio
"</span>
-<span class="name variable">R_SUGGESTS</span><span class="operator">=</span><span class="literal string double">"sci-R/sound
- sci-R/audio
+<span class="name variable">R_SUGGESTS</span><span class="operator">=</span><span class="literal string double">"
+ r_suggests_sound? ( sci-R/sound )
+ r_suggests_audio? ( sci-R/audio )
"</span>
<span class="name variable">DEPEND</span><span class="operator">=</span><span class="literal string double">"sci-R/fftw
sci-R/tuneR
@@ -1048,11 +1076,11 @@ inherit R-packages
sci-R/rpanel
sci-R/rgl
"</span>
-<span class="name variable">RDEPEND</span><span class="operator">=</span><span class="literal string double">"${DEPEND:-}
+<span class="name variable">RDEPEND</span><span class="operator">=</span><span class="literal string double">"${DEPEND-}
media-libs/flac
sci-libs/fftw
media-libs/libsndfile
- R_suggests? ( ${R_SUGGESTS} )
+ ${R_SUGGESTS-}
"</span>
</pre>
</dd>
@@ -1060,7 +1088,7 @@ inherit R-packages
<dd><p class="first">Note the shortened <em>DESCRIPTION</em> variable that points to the <em>metadata.xml</em>
file. This happens if the description is too long.</p>
<pre class="code sh last literal-block">
-<span class="comment"># Copyright 1999-2012 Gentoo Foundation
+<span class="comment"># Copyright 1999-2013 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: $
</span>
@@ -1070,21 +1098,29 @@ inherit R-packages
<span class="name variable">DESCRIPTION</span><span class="operator">=</span><span class="literal string double">"MetaPCA: Meta-analysis in the Di... (see metadata)"</span>
<span class="name variable">SRC_URI</span><span class="operator">=</span><span class="literal string double">"http://cran.r-project.org/src/contrib/Archive/MetaPCA/MetaPCA_0.1.3.tar.gz"</span>
-<span class="name variable">IUSE</span><span class="operator">=</span><span class="literal string double">"${IUSE:-}
- R_suggests
+<span class="name variable">IUSE</span><span class="operator">=</span><span class="literal string double">"${IUSE-}
+ r_suggests_domc
+ r_suggests_affy
+ r_suggests_ellipse
+ r_suggests_pcapp
+ r_suggests_mass
+ r_suggests_impute
+ r_suggests_dosmp
+ r_suggests_geoquery
"</span>
-<span class="name variable">R_SUGGESTS</span><span class="operator">=</span><span class="literal string double">"sci-R/doMC
- sci-R/affy
- sci-R/ellipse
- sci-R/pcaPP
- sci-R/MASS
- sci-R/impute
- sci-R/doSMP
- sci-R/GEOquery
+<span class="name variable">R_SUGGESTS</span><span class="operator">=</span><span class="literal string double">"
+ r_suggests_domc? ( sci-R/doMC )
+ r_suggests_affy? ( sci-R/affy )
+ r_suggests_ellipse? ( sci-R/ellipse )
+ r_suggests_pcapp? ( sci-R/pcaPP )
+ r_suggests_mass? ( sci-R/MASS )
+ r_suggests_impute? ( sci-R/impute )
+ r_suggests_dosmp? ( sci-R/doSMP )
+ r_suggests_geoquery? ( sci-R/GEOquery )
"</span>
<span class="name variable">DEPEND</span><span class="operator">=</span><span class="literal string double">"sci-R/foreach"</span>
-<span class="name variable">RDEPEND</span><span class="operator">=</span><span class="literal string double">"${DEPEND:-}
- R_suggests? ( ${R_SUGGESTS} )
+<span class="name variable">RDEPEND</span><span class="operator">=</span><span class="literal string double">"${DEPEND-}
+ ${R_SUGGESTS-}
"</span>
<span class="name variable">_UNRESOLVED_PACKAGES</span><span class="operator">=(</span><span class="literal string single">'hgu133plus2.db'</span><span class="operator">)</span>
@@ -2195,6 +2231,10 @@ This will pass '--bwlimit=<value>' to all rsync commands.</p>
<dt>ADDITIONS_DIR:</dt>
<dd>Alias to <a class="reference internal" href="#overlay-additions-dir">OVERLAY_ADDITIONS_DIR</a>.</dd>
</dl>
+<dl class="docutils" id="backup-desc">
+<dt>BACKUP_DESC</dt>
+<dd>Alias to <a class="reference internal" href="#overlay-backup-desc">OVERLAY_BACKUP_DESC</a>.</dd>
+</dl>
<dl class="docutils" id="distdir">
<dt>DISTDIR</dt>
<dd>Alias to <a class="reference internal" href="#overlay-distdir-root">OVERLAY_DISTDIR_ROOT</a>.</dd>
@@ -2207,6 +2247,10 @@ This will pass '--bwlimit=<value>' to all rsync commands.</p>
<dt>DISTDIR_STRATEGY</dt>
<dd>Alias to <a class="reference internal" href="#overlay-distdir-strategy">OVERLAY_DISTDIR_STRATEGY</a>.</dd>
</dl>
+<dl class="docutils" id="ebuild-use-expand-name">
+<dt>EBUILD_USE_EXPAND_NAME</dt>
+<dd>Name of the R_SUGGESTS USE_EXPAND variable. Defaults to <em>R_SUGGESTS</em>.</dd>
+</dl>
<dl class="docutils" id="eclass">
<dt>ECLASS</dt>
<dd>Alias to <a class="reference internal" href="#overlay-eclass">OVERLAY_ECLASS</a>.</dd>
@@ -2222,6 +2266,13 @@ ebuild patches and hand-written ebuilds. This option is not required.</p>
<p class="last">Defaults to <not set>, which disables this feature.</p>
</dd>
</dl>
+<dl class="docutils" id="overlay-backup-desc">
+<dt>OVERLAY_BACKUP_DESC</dt>
+<dd><p class="first">A <em>bool</em> that indicates whether the description file of the <em>R_SUGGESTS</em>
+USE_EXPAND variable should be backed up before (over-)writing it.</p>
+<p class="last">Defaults to <em>true</em>.</p>
+</dd>
+</dl>
<dl class="docutils" id="overlay-category">
<dt>OVERLAY_CATEGORY</dt>
<dd><p class="first">Sets the category of created ebuilds. There are no value type restrictions
@@ -2341,18 +2392,35 @@ writing.</p>
<p class="last">Defaults to <em>R_Overlay</em>.</p>
</dd>
</dl>
+<dl class="docutils" id="use-expand-name">
+<dt>USE_EXPAND_NAME:</dt>
+<dd>Alias to <a class="reference internal" href="#ebuild-use-expand-name">EBUILD_USE_EXPAND_NAME</a>.</dd>
+</dl>
</div>
<div class="section" id="other-config-files">
<h2><a class="toc-backref" href="#contents">9.3 other config files</a></h2>
<p>Some config config options are split from the main config file for various
reasons:</p>
<ul class="simple">
-<li>no need for modification in most cases, e.g. the <a class="reference internal" href="#id3">field definition</a> file</li>
+<li>no need for modification in most cases, e.g. the <a class="reference internal" href="#id4">field definition</a> file</li>
<li>special syntax that is not compatible with the main config file,
e.g. the <a class="reference internal" href="#dependency-rule-file-syntax">dependency rule file syntax</a></li>
</ul>
<p>The paths to these files have to be listed in the main config file and
can be overridden with the appropriate command line options.</p>
+<dl class="docutils" id="ebuild-use-expand-desc">
+<dt>EBUILD_USE_EXPAND_DESC</dt>
+<dd><p class="first">Path to a flag description file (for the <em>R_SUGGESTS</em> USE_EXPAND variable).
+The syntax of this file is identical to USE_EXPAND description files
+(<tt class="docutils literal"><overlay <span class="pre">root>/profiles/desc/r_suggests.desc</span></tt>).</p>
+<p class="last">Defaults to <not set>, which disables this option.</p>
+</dd>
+</dl>
+<dl class="docutils" id="ebuild-use-expand-rename">
+<dt>EBUILD_USE_EXPAND_RENAME</dt>
+<dd>Path to a file that lists alternative names for a flag in the <em>R_SUGGESTS</em>
+USE_EXPAND variable.</dd>
+</dl>
<dl class="docutils" id="field-definition">
<dt>FIELD_DEFINITION</dt>
<dd><p class="first">Path to the field definition file that controls how the <em>DESCRIPTION</em> file
@@ -2399,6 +2467,14 @@ much without dependency resolution.</p>
<dt>SIMPLE_RULES_FILES</dt>
<dd>Alias to <a class="reference internal" href="#simple-rules-file">SIMPLE_RULES_FILE</a>.</dd>
</dl>
+<dl class="docutils" id="use-expand-desc">
+<dt>USE_EXPAND_DESC</dt>
+<dd>Alias to <a class="reference internal" href="#ebuild-use-expand-desc">EBUILD_USE_EXPAND_DESC</a>.</dd>
+</dl>
+<dl class="docutils" id="use-expand-rename">
+<dt>USE_EXPAND_RENAME</dt>
+<dd>Alias to <a class="reference internal" href="#ebuild-use-expand-rename">EBUILD_USE_EXPAND_RENAME</a>.</dd>
+</dl>
</div>
<div class="section" id="logging">
<h2><a class="toc-backref" href="#contents">9.4 logging</a></h2>
@@ -2524,8 +2600,44 @@ on <em>roverlay</em> exit. Primarily useful for creating new rules.</p>
</dl>
</div>
</div>
+<div class="section" id="id3">
+<h1><a class="toc-backref" href="#contents">10 Other config files</a></h1>
+<div class="section" id="use-expand-flag-rename-file">
+<h2><a class="toc-backref" href="#contents">10.1 USE_EXPAND flag rename file</a></h2>
+<p>The <a class="reference internal" href="#use-expand-rename">USE_EXPAND_RENAME</a> file contains dictionary-like entries that assign
+<em>effective</em> flag names to flag names generated at runtime.</p>
+<p>The syntax is as follows:</p>
+<pre class="code text literal-block">
+# comments start with '#'
+
+<effective flag> <runtime flag> [<another runtime flag>...]
+
+# a '=' can be used as separator to improve readability
+<effective flag> = <runtime flag> [<another runtime flag>...]
+
+# the previous line can be continued with leading whitespace
+<effective flag> = <runtime flag>
+ [<another runtime flag>...]
+</pre>
+<p>Example:</p>
+<pre class="code text literal-block">
+# rename 'audio' and 'snd' to 'sound'
+sound = audio snd
+</pre>
+<p>Each flag is renamed at most once, so the following example renames 'sound'
+to media, but 'audio' to 'sound':;</p>
+<pre class="code text literal-block">
+sound = audio snd
+media = sound video
+</pre>
+<div class="caution">
+<p class="first admonition-title">Caution!</p>
+<p class="last">Assigning more than one <em>effective flag</em> to a <em>runtime flag</em> leads to
+unpredictable results.</p>
+</div>
+</div>
<div class="section" id="field-definition-config">
-<span id="id3"></span><h1><a class="toc-backref" href="#contents">10 Field Definition Config</a></h1>
+<span id="id4"></span><h2><a class="toc-backref" href="#contents">10.2 Field Definition Config</a></h2>
<p>The field definition file uses <a class="reference external" href="http://docs.python.org/library/configparser.html">ConfigParser</a> syntax and defines
how an R package's DESCRIPTION file is read.
See the next section, <a class="reference internal" href="#default-field-definition-file">default field definition file</a>, for an example.</p>
@@ -2607,7 +2719,7 @@ such a field is found.</dd>
<p class="last">It is not checked whether a flag is known or not.</p>
</div>
<div class="section" id="example-the-default-field-definition-file">
-<span id="default-field-definition-file"></span><h2><a class="toc-backref" href="#contents">10.1 Example: The default field definition file</a></h2>
+<span id="default-field-definition-file"></span><h3><a class="toc-backref" href="#contents">10.2.1 Example: The default field definition file</a></h3>
<p>This is the default field definition file (without any ignored fields):</p>
<pre class="code ini literal-block">
<span class="keyword">[Description]</span>
@@ -2642,6 +2754,7 @@ such a field is found.</dd>
</pre>
</div>
</div>
+</div>
<div class="section" id="dependency-resolution-console">
<span id="depres-console"></span><h1><a class="toc-backref" href="#contents">11 Dependency Resolution Console</a></h1>
<p>As previously stated, the <em>DepRes Console</em> is only meant for <strong>testing</strong>.
@@ -3315,7 +3428,7 @@ becomes "loop until resolver closes".</p>
</div>
<div class="footer">
<hr class="footer" />
-Generated on: 2013-06-12.
+Generated on: 2013-06-18.
</div>
</body>
next reply other threads:[~2013-06-18 14:13 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-06-18 14:12 André Erdmann [this message]
2013-06-18 14:12 ` [gentoo-commits] proj/R_overlay:master commit in: doc/html/ André Erdmann
-- strict thread matches above, loose matches on Subject: below --
2013-07-23 14:57 André Erdmann
2013-07-23 14:57 ` [gentoo-commits] proj/R_overlay:gsoc13/next " André Erdmann
2013-07-16 16:35 André Erdmann
2013-07-10 16:16 [gentoo-commits] proj/R_overlay:master " André Erdmann
2013-07-10 15:10 ` [gentoo-commits] proj/R_overlay:gsoc13/next " André Erdmann
2013-07-03 10:04 André Erdmann
2013-06-26 17:29 André Erdmann
2013-06-12 21:10 André Erdmann
2013-06-05 18:08 André Erdmann
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1371560085.7bb0058e0639e2829eae14dd0bef98e230ef60dc.dywi@gentoo \
--to=dywi@mailerd.de \
--cc=gentoo-commits@lists.gentoo.org \
--cc=gentoo-dev@lists.gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox