aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-01-07 17:34:44 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-01-07 17:34:44 +0000
commit091da5a817b6333829178fb22ab4604f90b842b0 (patch)
treef72b8e83e196d58e8fd521732cc4935d1abac0a2
parent8179475606c74fb26c47a3dae7d0fb5042aa7e68 (diff)
downloadpaludis-091da5a817b6333829178fb22ab4604f90b842b0.tar.gz
paludis-091da5a817b6333829178fb22ab4604f90b842b0.tar.xz
Docs updates
-rw-r--r--doc/configuration.html.skel8
-rw-r--r--doc/faq.html.skel100
2 files changed, 92 insertions, 16 deletions
diff --git a/doc/configuration.html.skel b/doc/configuration.html.skel
index 0047e06..c89f6c4 100644
--- a/doc/configuration.html.skel
+++ b/doc/configuration.html.skel
@@ -98,10 +98,10 @@ be considered, not just the best or last match.</p>
<h3>The keywords.conf File</h3>
-<p>Which <code>ARCH KEYWORDS</code> to accept is controlled by the
+<p>Which <code>ARCH KEYWORDS</code> to accept is controlled by the
<code>keywords.conf</code> file. The format of a line is
<code>atom keyword1 keywords2 ...</code>, where <code>atom</code> is a package
-depend atom, <a href="sets.html">set name</a> or <code>*</code> for "all packages" and
+depend atom, <a href="sets.html">set name</a> or <code>*</code> for "all packages" and
<code>keyword1 keyword2 ...</code> is one or more arch keywords. As with Portage,
accepting <code>~arch</code> does <em>not</em>
implicitly accept <code>arch</code>, however, if a package matches multiple lines,
@@ -123,6 +123,10 @@ portage tree that if <code>~ARCH</code> is accepted for a package, then so is
<code>ARCH</code>; not doing so may result in all versions or the latest version of a
package being masked, as the package is stabilised.</p>
+<p>The <code>-*</code> special keyword can be used to remove previously accepted
+keywords from a less specific match. The <code>*</code> special keyword can be
+used to accept anything.</p>
+
<h3>The package_mask.conf File</h3>
<p>Packages can be masked through the use of the <code>package_mask.conf</code>
diff --git a/doc/faq.html.skel b/doc/faq.html.skel
index c1b1a64..58b9de4 100644
--- a/doc/faq.html.skel
+++ b/doc/faq.html.skel
@@ -23,6 +23,20 @@ functionality. Pestering anyone about these is liable to get you hurt a lot.</p>
<h2 id="general">General Paludis Questions</h2>
+<h3 id="ihaveaquestion">I have an Unanswered Question</h3>
+
+<p>If you've checked the documentation, and your question really isn't answered,
+you should ask it in one of these places:</p>
+
+<ul>
+ <li>The <code>#paludis</code> channel on <code>irc.freenode.net</code></li>
+ <li>The <a href="https://developer.berlios.de/mail/?group_id=6360">paludis-user
+ mailing list</a></li>
+</ul>
+
+<p>You are encouraged to submit an entry for this document once your question
+has been answered.</p>
+
<h3 id="why">Why not fix Portage?</h3>
<p>The Portage codebase is too broken to be fixed. It is a huge mess of
@@ -143,6 +157,52 @@ use <code>--pretend</code> and check the output before proceeding:</p>
often used to mean "compile against one of these".</li>
</ul>
+<h3 id="unmask">Unmask a Package</h3>
+
+<p>First, you need to determine how a package is masked. The easiest way to do
+this is to use <code>paludis --query</code>. Then, if you're sure you really
+want to unmask a package, and bearing in mind that doing so might break your
+system, you need to override the mask. How to do this depends upon the mask
+reasons:</p>
+
+<dl>
+ <dt>keyword</dt>
+
+ <dd>You need to add an entry to your <code>keywords.conf</code> accepting
+ one of the ebuild's keywords. The special <code>-*</code> keyword cannot be
+ accepted this way; if an ebuild only has this in its keywords, report it
+ to <a href="https://bugs.gentoo.org/show_bug.cgi?id=160519">Gentoo bug
+ 160519</a> and work around it by using <code>*</code>.</dd>
+
+ <dt>user mask</dt>
+
+ <dd>Either remove your <code>package_mask.conf</code> entry or override it
+ with <code>package_unmask.conf</code>.</dd>
+
+ <dt>profile mask</dt>
+
+ <dd>Override with <code>package_unmask.conf</code>.</dd>
+
+ <dt>repository mask</dt>
+
+ <dd>Override with <code>package_unmask.conf</code>.</dd>
+
+ <dt>eapi</dt>
+
+ <dd>You cannot override this mask. It indicates either a broken ebuild (if
+ <code>EAPI=unknown</code> or an ebuild not supported by your current version
+ of Paludis.</dd>
+
+ <dt>license</dt>
+
+ <dd>Accept the appropriate licences in <code>licenses.conf</code>.</dd>
+
+ <dt>by association</dt>
+
+ <dd>Unmask the associated package. This mask reason is currently only used
+ for old style virtuals.</dd>
+</dl>
+
<h2 id="stricter">Paludis is Stricter than Portage</h2>
<h3 id="mergingweirdstuff">Merging Weird Stuff</h3>
@@ -202,20 +262,6 @@ honour <code>ROOT</code>. To temporarily disable sandbox for these packages,
<code>export SANDBOX_PREDICT=/</code> or <code>export SANDBOX_WRITE=/</code> as
appropriate.</p>
-<h3 id="repo_name">Repository names</h3>
-
-<p>Because of a requirement forced into <a
- href="http://www.gentoo.org/proj/en/glep/glep-0042.html">GLEP 42</a> by the
-peanut gallery, repositories are required to be uniquely identifiable. The
-identifier must remain consistent even if a repository is moved, either locally
-or remotely, and thus must be independent of user configuration.</p>
-
-<p>For Portage format repositories, this is controlled by the <code>profiles/repo_name</code>
-file. It should contain a single string with no whitespace or funny characters.
-For many repositories, this has already been created for you; for some overlays,
-probably including your local overlay if you have one, the file is not yet
-there so you will have to create it.</p>
-
<h2 id="misfunctionality">Undesirable Misfunctionality</h2>
<h3 id="wgetresume">wget Resume Support</h3>
@@ -333,6 +379,32 @@ a rather ugly way of handling things. We do have equivalents to most values:</p>
<code>src_test</code></a>.</dd>
</dl>
+<h2 id="repos">Repository Questions</h2>
+
+<h3 id="profiles">Profiles vs Profiles</h3>
+
+<p>Don't confuse the <code>profiles/</code> directory with the <code>profiles
+ =</code> setting for Portage format repositories. The special files
+immediately under <code>profiles/</code>, such as
+<code>profiles/thirdpartymirrors</code>, <code>profiles/use.desc</code>
+and <code>profiles/package.mask</code>, are specific to that particular profile
+and no other; the <code>profiles =</code> key has no effect upon them.</p>
+
+<h3 id="repo_name">Repository names</h3>
+
+<p>Because of a requirement forced into <a
+ href="http://www.gentoo.org/proj/en/glep/glep-0042.html">GLEP 42</a> by the
+peanut gallery, repositories are required to be uniquely identifiable. The
+identifier must remain consistent even if a repository is moved, either locally
+or remotely, and thus must be independent of user configuration.</p>
+
+<p>For Portage format repositories, this is controlled by the <code>profiles/repo_name</code>
+file. It should contain a single string with no whitespace or funny characters.
+For many repositories, this has already been created for you; for some overlays,
+probably including your local overlay if you have one, the file is not yet
+there so you will have to create it.</p>
+
+
@FOOTER@
</body>
</html>