aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2009-02-16 19:07:56 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2009-02-16 19:07:56 +0000
commit43e28d7cb6db07b0e4bd2d7085666446477f0264 (patch)
tree3318b97981c4d94f536e11de43b7222e281305e7
parent6e08fbefeecfbe5ecdf7615bf4bf3941a2b68dec (diff)
downloadpaludis-43e28d7cb6db07b0e4bd2d7085666446477f0264.tar.gz
paludis-43e28d7cb6db07b0e4bd2d7085666446477f0264.tar.xz
Document Exherbo config filenames.
Fixes: ticket:722
-rw-r--r--doc/configuration/index.html.part6
-rw-r--r--doc/configuration/keywords.html.part.in21
-rw-r--r--doc/configuration/licenses.html.part.in14
-rw-r--r--doc/configuration/toplinks.html.part.in6
-rw-r--r--doc/configuration/use.html.part.in25
-rw-r--r--doc/index.html.part.in6
6 files changed, 44 insertions, 34 deletions
diff --git a/doc/configuration/index.html.part b/doc/configuration/index.html.part
index 6914cd1..2431b53 100644
--- a/doc/configuration/index.html.part
+++ b/doc/configuration/index.html.part
@@ -26,9 +26,9 @@
<li><a href="specs.html">Dependency specifications</a> in general.</li>
<li><a href="specpath.html">specpath.conf</a>, and where Paludis looks for configuration files.</li>
<li><a href="environment.html">environment.conf</a>: for environment options.</li>
- <li><a href="keywords.html">keywords.conf</a>: for keywords.</li>
- <li><a href="use.html">use.conf</a>: for USE flags.</li>
- <li><a href="licenses.html">licenses.conf</a>: for licence filtering.</li>
+ <li><a href="keywords.html">keywords.conf or platforms.conf</a>: for keywords or platforms.</li>
+ <li><a href="use.html">use.conf or options.conf</a>: for USE flags or options.</li>
+ <li><a href="licenses.html">licenses.conf or licences.conf</a>: for licence filtering.</li>
<li><a href="mirrors.html">mirrors.conf</a>: for mirrors.</li>
<li><a href="packagemask.html">package_mask.conf and package_unmask.conf</a>: for masks.</li>
<li><a href="bashrc.html">bashrc</a>: for package build environment options.</li>
diff --git a/doc/configuration/keywords.html.part.in b/doc/configuration/keywords.html.part.in
index 3e16158..b21ac26 100644
--- a/doc/configuration/keywords.html.part.in
+++ b/doc/configuration/keywords.html.part.in
@@ -1,15 +1,16 @@
<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
-<h1>keywords.conf</h1>
+<h1>keywords.conf / platforms.conf</h1>
###PALUDISENVIRONMENTONLY###
-<p>The <code>keywords.conf</code> file controls which keywords are and are not accepted. It is a standard configuration
-file which may be a bash file (<code>keywords.bash</code>) and which may use the <code>keywords.conf.d/</code>
-directory.</p>
+<p>The <code>keywords.conf</code> (Gentoo and derived distributions) or <code>platforms.conf</code> (Exherbo) file
+controls which keywords are and are not accepted. It is a standard configuration file which may be a bash file
+(<code>keywords.bash</code> or <code>platforms.bash</code>) and which may use the <code>keywords.conf.d/</code> or
+<code>platforms.conf.d/</code> directory.</p>
-<p>Each line in the file consists of a specification followed by one or more accepted keywords. A specification may be
-any of:</p>
+<p>Each line in the file consists of a specification followed by one or more accepted keywords or platforms. A
+specification may be any of:</p>
<ul>
<li>The special specification <code>*/*</code>, which matches all packages. Nearly all users will have at least one
@@ -21,18 +22,18 @@ any of:</p>
<p>Any token may be quoted using either single or double quotes.</p>
-<p>Accepted keywords are one of:</p>
+<p>Accepted keywords pr platforms are one of:</p>
<ul>
<li><code>keyword</code>, which accepts any package containing that keyword.</li>
<li><code>~keyword</code>, which accepts any package containing that ~keyword. This does <em>not</em> automatically
accept the regular, non-tilde keyword.</li>
- <li><code>*</code>, which accepts any package, including one with empty keywords.</li>
+ <li><code>*</code>, which accepts any package, including one with empty keywords or platforms.</li>
<li><code>-*</code>, which cancels any previously accepted match (see below).</li>
</ul>
-<p>Accepted keywords are usually cumulative, so if you have a <code>*/* arch ~arch</code> line, you will need to use
-<code>cat/pkg -* arch</code> if you only wish to accept <code>arch</code> for a particular package.</p>
+<p>Accepted keywords or platforms are usually cumulative, so if you have a <code>*/* arch ~arch</code> line, you will
+need to use <code>cat/pkg -* arch</code> if you only wish to accept <code>arch</code> for a particular package.</p>
<h2>Examples</h2>
diff --git a/doc/configuration/licenses.html.part.in b/doc/configuration/licenses.html.part.in
index 700ce32..e0236b5 100644
--- a/doc/configuration/licenses.html.part.in
+++ b/doc/configuration/licenses.html.part.in
@@ -1,17 +1,21 @@
<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
-<h1>licenses.conf</h1>
+<h1>licenses.conf / licences.conf</h1>
###PALUDISENVIRONMENTONLY###
<div class="note">
<p>We apologise for misspelling 'licence' as 'license' throughout. This is done to match the ebuild variable
- 'LICENSE', whose name cannot be fixed for historical reasons.</p>
+ 'LICENSE', whose name cannot be fixed for Gentoo-based distributions for historical reasons.</p>
</div>
-<p>The <code>license.conf</code> file controls which licenses are and are not accepted. It is a standard configuration
-file which may be a bash file (<code>license.bash</code>) and which may use the <code>licenses.conf.d/</code>
-directory.</p>
+<p>On Gentoo and derived distributions, the <code>license.conf</code> file controls which licenses are and are not
+accepted. It is a standard configuration file which may be a bash file (<code>license.bash</code>) and which may use the
+<code>licenses.conf.d/</code> directory.</p>
+
+<p>On Exherbo, the <code>licence.conf</code> file controls which licences are and are not accepted. It is a standard
+configuration file which may be a bash file (<code>licence.bash</code>) and which may use the
+<code>licences.conf.d/</code> directory.</p>
<p>Each line in the file consists of a specification followed by one or more license symbols. A specification may be
any of:</p>
diff --git a/doc/configuration/toplinks.html.part.in b/doc/configuration/toplinks.html.part.in
index cae0ae4..694025a 100644
--- a/doc/configuration/toplinks.html.part.in
+++ b/doc/configuration/toplinks.html.part.in
@@ -36,7 +36,7 @@
</td>
<td class="currentpage">
- <a href="###TOPURI###configuration/keywords.html">keywords.conf</a>
+ <a href="###TOPURI###configuration/keywords.html">keywords.conf / platforms.conf</a>
</td>
<td class="currentpage">
@@ -54,7 +54,7 @@
</td>
<td class="currentpage">
- <a href="###TOPURI###configuration/use.html">use.conf</a>
+ <a href="###TOPURI###configuration/use.html">use.conf / options.conf</a>
</td>
<td class="currentpage">
@@ -72,7 +72,7 @@
</td>
<td class="currentpage">
- <a href="###TOPURI###configuration/licenses.html">licenses.conf</a>
+ <a href="###TOPURI###configuration/licenses.html">licenses.conf / licences.conf</a>
</td>
<td class="currentpage">
diff --git a/doc/configuration/use.html.part.in b/doc/configuration/use.html.part.in
index 74b8cbc..30be775 100644
--- a/doc/configuration/use.html.part.in
+++ b/doc/configuration/use.html.part.in
@@ -1,14 +1,19 @@
<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
-<h1>use.conf</h1>
+<h1>use.conf / options.conf</h1>
###PALUDISENVIRONMENTONLY###
-<p>The <code>use.conf</code> file controls which use flags are and are not enabled. It is a standard configuration
-file which may be a bash file (<code>use.bash</code>) and which may use the <code>use.conf.d/</code> directory.</p>
+<p>On Gentoo and derived distributions, the <code>use.conf</code> file controls which use flags are and are not enabled.
+It is a standard configuration file which may be a bash file (<code>use.bash</code>) and which may use the
+<code>use.conf.d/</code> directory.</p>
-<p>Each line in the file consists of a specification followed by one or more use flags and labels. A specification may be
-any of:</p>
+<p>On Exherbo, the <code>options.conf</code> file controls which options are and are not enabled. It is a standard
+configuration file which may be a bash file (<code>options.bash</code>) and which may use the
+<code>options.conf.d/</code> directory.</p>
+
+<p>Each line in the file consists of a specification followed by one or more use or option flags and labels. A
+specification may be any of:</p>
<ul>
<li>The special specification <code>*/*</code>, which matches all packages. Nearly all users will have at least one
@@ -25,15 +30,15 @@ any of:</p>
<ul>
<li><code>flag</code>, which enables that flag.</li>
<li><code>-flag</code>, which disables that flag.</li>
- <li><code>label:</code>, which marks any subsequent flags on that line as applying to a particular use expand label.
- Common examples of use expand labels are <code>VIDEO_CARDS</code>, <code>LINGUAS</code> and
- <code>INPUT_DEVICES</code>, as well as the special <code>BUILD_OPTIONS</code> label described below. Labels
- are <em>not</em> case sensitive.</li>
+ <li><code>label:</code>, which marks any subsequent flags on that line as applying to a particular use expand
+ (Gentoo) or suboption (Exherbo) label. Common examples of use expand labels are <code>VIDEO_CARDS</code>,
+ <code>LINGUAS</code> and <code>INPUT_DEVICES</code>, as well as the special <code>BUILD_OPTIONS</code> label
+ described below. Labels are <em>not</em> case sensitive.</li>
<li><code>-*</code>, which disables all flags for the current label, or all flags that are not a label if there is
no current label.</li>
</ul>
-<p>Use flag settings are cumulative. This applies to expanded use flags too, so if you do not wish to inherit, say,
+<p>Flag settings are cumulative. This applies to expanded flags too, so if you do not wish to inherit, say,
default <code>VIDEO_CARDS</code> from your profile, you will need to use <code>*/* VIDEO_CARDS: -* radeon</code>.</p>
<h2>Special Flags</h2>
diff --git a/doc/index.html.part.in b/doc/index.html.part.in
index f1b8f59..afcd2fa 100644
--- a/doc/index.html.part.in
+++ b/doc/index.html.part.in
@@ -57,9 +57,9 @@ the exheres repository format.</p>
<li><a href="configuration/specs.html">Dependency specifications</a> in general.</li>
<li><a href="configuration/specpath.html">specpath.conf</a>, and where Paludis looks for configuration files.</li>
<li><a href="configuration/environment.html">environment.conf</a>: for environment options.</li>
- <li><a href="configuration/keywords.html">keywords.conf</a>: for keywords.</li>
- <li><a href="configuration/use.html">use.conf</a>: for USE flags.</li>
- <li><a href="configuration/licenses.html">licenses.conf</a>: for licence filtering.</li>
+ <li><a href="configuration/keywords.html">keywords.conf or platforms.conf</a>: for keywords or platforms.</li>
+ <li><a href="configuration/use.html">use.conf or options.conf</a>: for USE flags or options.</li>
+ <li><a href="configuration/licenses.html">licenses.conf or licences.conf</a>: for licence filtering.</li>
<li><a href="configuration/mirrors.html">mirrors.conf</a>: for mirrors.</li>
<li><a href="configuration/packagemask.html">package_mask.conf and package_unmask.conf</a>: for masks.</li>
<li><a href="configuration/bashrc.html">bashrc</a>: for package build environment options.</li>