aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-10-25 14:55:15 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-10-25 14:55:15 +0000
commit4095dc519737a4410c94bc863bc2f0b607fef0f0 (patch)
treeb49b1114ad3df41d68a2bbb1a335b5372f632633
parentd7a014f9761f2bc36d7ff10d83c364cd2a2d5e83 (diff)
downloadpaludis-4095dc519737a4410c94bc863bc2f0b607fef0f0.tar.gz
paludis-4095dc519737a4410c94bc863bc2f0b607fef0f0.tar.xz
Various documentation updates. From Richard Brown.
-rw-r--r--doc/doc_configuration_files.doxygen30
1 files changed, 17 insertions, 13 deletions
diff --git a/doc/doc_configuration_files.doxygen b/doc/doc_configuration_files.doxygen
index 465b5cd..9c6ee34 100644
--- a/doc/doc_configuration_files.doxygen
+++ b/doc/doc_configuration_files.doxygen
@@ -82,10 +82,14 @@ be considered, not just the best or last match.
\section ConfigurationFilesKeywordsConf The keywords.conf File
-Which <code>KEYWORDS</code> to accept is controlled through
-<code>keywords.conf</code>. The format of a line is
-<code>atom keyword ...</code>. As with Portage, accepting
-<code>~arch</code> does <em>not</em> implicitly accept <code>arch</code>.
+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 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,
+<em>all</em> of these lines will be considered, not just the best or last match.
For example:
\verbatim
@@ -93,16 +97,16 @@ For example:
* x86
# But some ~arch packages:
-dev-cpp/libebt x86 ~x86
-sys-apps/paludis x86 ~x86
-dev-util/subversion x86 ~x86
-app-admin/eselect x86 ~x86
-app-editors/vim x86 ~x86
-app-editors/vim-core x86 ~x86
+app-editors/vim ~x86
+app-editors/vim-core ~x86
\endverbatim
-Note that if a package matches multiple lines, <em>all</em> of these lines will
-be considered, not just the best or last match.
+If <code>*</code> is not used, then every package that is to be installed will require
+an entry in <code>keywords.conf</code>. It is also generally assumed within the gentoo
+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.
+
\section ConfigurationFilesPackage_MaskConf The package_mask.conf File
@@ -123,7 +127,7 @@ Packages can be unmasked through the use of the <code>package_unmask.conf</code>
\verbatim
# I need banshee 0.11.0
-media-sound/banshee
+=media-sound/banshee-0.11.0
\endverbatim
\section ConfigurationFilesLicensesConf The licenses.conf File