1 |
Author: genone |
2 |
Date: 2008-05-02 10:46:47 +0000 (Fri, 02 May 2008) |
3 |
New Revision: 10086 |
4 |
|
5 |
Modified: |
6 |
main/trunk/doc/config/sets.docbook |
7 |
Log: |
8 |
Update documentation for package set configuration. Original patch by Arfrever Frehtes Taifersar Arahesis |
9 |
|
10 |
Modified: main/trunk/doc/config/sets.docbook |
11 |
=================================================================== |
12 |
--- main/trunk/doc/config/sets.docbook 2008-05-02 10:04:20 UTC (rev 10085) |
13 |
+++ main/trunk/doc/config/sets.docbook 2008-05-02 10:46:47 UTC (rev 10086) |
14 |
@@ -49,12 +49,13 @@ |
15 |
isn't stricly required, but it should always be used as the default |
16 |
handler might be changed in future versions.</para></footnote>. |
17 |
That option defines which handler class should be used to |
18 |
- create the set. Another universal option available for single sets is |
19 |
- <varname>name</varname>, however it's usually not needed as the name |
20 |
+ create the set. Other universal options available for single sets are |
21 |
+ <varname>name</varname> (which is usually not needed as the name |
22 |
of the set is generated from the section name if <varname>name</varname> |
23 |
- is missing. Some handler classes might require additional |
24 |
- options for their configuration, these will be covered later in |
25 |
- this chapter. |
26 |
+ is missing) and <varname>world-candidate</varname>, which determines if |
27 |
+ given package should be added to the <varname>world</varname> set. Some |
28 |
+ handler classes might require additional options for their configuration, |
29 |
+ these will be covered later in this chapter. |
30 |
</para> |
31 |
<para> |
32 |
Here are a few examples for single sets taken from the default |
33 |
@@ -63,6 +64,7 @@ |
34 |
# The classic world set |
35 |
[world] |
36 |
class = portage.sets.files.WorldSet |
37 |
+ world-candidate = False |
38 |
|
39 |
# The classic system set |
40 |
[system] |
41 |
@@ -81,7 +83,8 @@ |
42 |
sets each section still requires the <varname>class</varname> option, |
43 |
but to indicate that the section should generate multiple sets it's |
44 |
also necessary to set the <varname>multiset</varname> option to |
45 |
- <parameter>true</parameter>. |
46 |
+ <parameter>true</parameter>. The <varname>world-candidate</varname> |
47 |
+ option is also supported like with single sets. |
48 |
</para> |
49 |
<para> |
50 |
As it doesn't make much sense to specify a single name for multiple sets |
51 |
@@ -157,6 +160,11 @@ |
52 |
<itemizedlist> |
53 |
<listitem><varname>filename</varname>: Required. Specifies the path to the file |
54 |
that should be used for the package set.</listitem> |
55 |
+ <listitem><varname>greedy</varname>: Optional, defaults to <parameter>false</parameter>. |
56 |
+ Determines if atoms in the package should include all installed slots (when set to |
57 |
+ <parameter>true</parameter>) or if no slot expansion is wanted (when set to |
58 |
+ <parameter>false</parameter>). This option only affects packages that have multiple |
59 |
+ slots available (e.g. <parameter>sys-kernel/gentoo-sources</parameter>).</listitem> |
60 |
</itemizedlist> |
61 |
</para> |
62 |
</sect3> |
63 |
@@ -172,7 +180,7 @@ |
64 |
that location a separate package set is created. |
65 |
</listitem> |
66 |
<listitem><varname>name_pattern</varname>: Optional, defaults to |
67 |
- <parameter>sets/$name</parameter>. This describes the naming pattern |
68 |
+ <parameter>$name</parameter>. This describes the naming pattern |
69 |
to be used for creating the sets. It must contain either |
70 |
<parameter>$name</parameter> or <parameter>${name}</parameter>, which |
71 |
will be replaced by the filename (without any directory components). |
72 |
@@ -218,7 +226,7 @@ |
73 |
No other files in that directory will be used. |
74 |
</listitem> |
75 |
<listitem><varname>name_pattern</varname>: Optional, defaults to |
76 |
- <parameter>sets/package_$suffix</parameter>. This describes the naming |
77 |
+ <parameter>package_$suffix</parameter>. This describes the naming |
78 |
pattern to be used for creating the sets. It must contain either |
79 |
<parameter>$suffix</parameter> or <parameter>${suffix}</parameter>, |
80 |
which will be replaced by the file suffix (e.g. |
81 |
@@ -240,7 +248,7 @@ |
82 |
<sect3> |
83 |
<title>Single Set Configuraton</title> |
84 |
<para> |
85 |
- This class does not support any options. |
86 |
+ This class doesn't support any extra options. |
87 |
</para> |
88 |
</sect3> |
89 |
</sect2> |
90 |
@@ -258,7 +266,7 @@ |
91 |
<sect3> |
92 |
<title>Single Set Configuration</title> |
93 |
<para> |
94 |
- This class does not support any options. |
95 |
+ This class doesn't support any extra options. |
96 |
</para> |
97 |
</sect3> |
98 |
</sect2> |
99 |
@@ -441,10 +449,29 @@ |
100 |
<sect3> |
101 |
<title>Single Set Configuration</title> |
102 |
<para> |
103 |
- This class does not support any options. |
104 |
+ This class doesn't support any extra options. |
105 |
</para> |
106 |
</sect3> |
107 |
</sect2> |
108 |
+ <sect2 id='config-set-classes-PreservedLibraryConsumerSet'> |
109 |
+ <title>portage.sets.libs.PreservedLibraryConsumerSet</title> |
110 |
+ <para> |
111 |
+ A special set used to rebuild all packages that need a preserved library that only |
112 |
+ remains due to <varname>FEATURES="preserve-libs"</varname>. |
113 |
+ </para> |
114 |
+ |
115 |
+ <sect3> |
116 |
+ <title>Single Set Configuration</title> |
117 |
+ <para> |
118 |
+ This class supports the following option: |
119 |
+ <itemizedlist> |
120 |
+ <listitem><varname>debug</varname>: Generate extra output useful to figure out why |
121 |
+ certain packages are included in the set, as it's not always obvious. |
122 |
+ </listitem> |
123 |
+ </itemizedlist> |
124 |
+ </para> |
125 |
+ </sect3> |
126 |
+ </sect2> |
127 |
</sect1> |
128 |
|
129 |
<sect1 id='config-set-defaults'> |
130 |
@@ -462,6 +489,7 @@ |
131 |
<listitem><varname>world</varname>: uses <classname>WorldSet</classname></listitem> |
132 |
<listitem><varname>security</varname>: uses <classname>NewAffectedSet</classname> with default options</listitem> |
133 |
<listitem><varname>everything</varname>: uses <classname>EverythingSet</classname></listitem> |
134 |
+ <listitem><varname>preserved-rebuild</varname>: uses <classname>PreservedLibraryConsumerSet</classname></listitem> |
135 |
</itemizedlist> |
136 |
Additionally the default configuration includes a multi set section based on |
137 |
the <classname>StaticFileSet</classname> defaults that creates a set for each |
138 |
|
139 |
-- |
140 |
gentoo-commits@l.g.o mailing list |