| 1 | <?xml version='1.0' encoding="UTF-8"?> |
1 | <?xml version='1.0' encoding="UTF-8"?> |
| 2 | <!DOCTYPE guide SYSTEM "htdocs/dtd/guide.dtd"> |
2 | <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 3 | <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/distcc.xml,v 1.2 2003/09/08 07:04:10 blubber Exp $ --> |
3 | <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/distcc.xml,v 1.40 2007/06/21 23:46:16 rane Exp $ --> |
| 4 | |
4 | |
| 5 | <guide link="/doc/en/distcc.xml"> |
5 | <guide link="/doc/en/distcc.xml"> |
| 6 | |
6 | |
| 7 | <title>Gentoo Distcc Documentation</title> |
7 | <title>Gentoo Distcc Documentation</title> |
| 8 | |
8 | |
| 9 | <author title="Author"> |
9 | <author title="Author"> |
| 10 | <mail link="lisa@gentoo.org">lisa@gentoo.org</mail> |
10 | <mail link="lisa@gentoo.org">Lisa Seelye</mail> |
| 11 | </author> |
11 | </author> |
| 12 | |
12 | <author title="Editor"> |
|
|
13 | <mail link="vapier@gentoo.org">Mike Frysinger</mail> |
|
|
14 | </author> |
|
|
15 | <author title="Editor"> |
|
|
16 | <mail link="erwin@gentoo.org">Erwin</mail> |
|
|
17 | </author> |
|
|
18 | <author title="Editor"> |
|
|
19 | <mail link="swift@gentoo.org">Sven Vermeulen</mail> |
|
|
20 | </author> |
|
|
21 | <author title="Editor"> |
|
|
22 | <mail link="pylon@gentoo.org">Lars Weiler</mail> |
|
|
23 | </author> |
| 13 | <author title="Reviewer"> |
24 | <author title="Reviewer"> |
| 14 | <mail link="swift@gentoo.org">swift@gentoo.org</mail> |
|
|
| 15 | </author> |
|
|
| 16 | |
|
|
| 17 | <author title="Reviewer"> |
|
|
| 18 | <mail link="blubber@gentoo.org">blubber@gentoo.org</mail> |
25 | <mail link="blubber@gentoo.org">Tiemo Kieft</mail> |
| 19 | </author> |
26 | </author> |
| 20 | |
27 | |
|
|
28 | <abstract> |
|
|
29 | This document serves as a HOWTO for using distcc with Gentoo. |
|
|
30 | </abstract> |
|
|
31 | |
|
|
32 | <!-- The content of this document is licensed under the CC-BY-SA license --> |
|
|
33 | <!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
|
|
34 | <license/> |
|
|
35 | |
| 21 | <version>1.1</version> |
36 | <version>1.19</version> |
| 22 | <date>September 08, 2003</date> |
37 | <date>2007-06-22</date> |
| 23 | |
|
|
| 24 | <abstract>This document serves as a HOWTO for using distcc with Gentoo.</abstract> |
|
|
| 25 | |
38 | |
| 26 | <chapter> |
39 | <chapter> |
| 27 | <title>Introduction</title> |
40 | <title>Introduction</title> |
| 28 | <section> |
41 | <section> |
| 29 | <title>What is distcc?</title> |
42 | <title>What is distcc?</title> |
| 30 | <body> |
43 | <body> |
| 31 | <p>Distcc is a program designed to distribute compiling tasks across a network to participating hosts. It is comprised of a server, <c>distccd</c> and a client program, <c>distcc</c>. Distcc can work transparently with <uri link="http://ccache.samba.org">ccache</uri> and Portage with a little set up.</p> |
44 | |
|
|
45 | <p> |
|
|
46 | Distcc is a program designed to distribute compiling tasks across a network to |
|
|
47 | participating hosts. It is comprised of a server, <c>distccd</c>, and a client |
|
|
48 | program, <c>distcc</c>. Distcc can work transparently with <uri |
|
|
49 | link="http://ccache.samba.org">ccache</uri>, Portage, and Automake with a |
|
|
50 | little setup. |
|
|
51 | </p> |
|
|
52 | |
| 32 | </body> |
53 | </body> |
| 33 | </section> |
54 | </section> |
| 34 | |
|
|
| 35 | <section> |
55 | <section> |
| 36 | <title>Dependancies</title> |
56 | <title>Using distcc to bootstrap</title> |
| 37 | <body> |
57 | <body> |
| 38 | <pre caption="Distcc Dependancies"> |
58 | |
| 39 | >=sys-apps/portage-2.0.46-r11 |
59 | <p> |
| 40 | >=sys-devel/gcc-config-1.3.1 |
60 | If you are planning on using distcc to help you bootstrap a Gentoo |
| 41 | >sys-apps/shadow |
61 | installation, make sure you read the section <uri link="#bootstrapping">Using |
| 42 | <codenote>(As of version 2.8) And the following optional dependancies when you have <c>gtk</c> in your <c>USE</c> flags</codenote> |
62 | distcc to Bootstrap</uri>, which is situated further down in this document. |
| 43 | >=x11-libs/gtk+-2.2.1 |
63 | </p> |
| 44 | </pre> |
64 | |
| 45 | </body> |
65 | </body> |
| 46 | </section> |
66 | </section> |
| 47 | </chapter> |
67 | </chapter> |
| 48 | |
68 | |
| 49 | <chapter> |
69 | <chapter> |
| 50 | <title>Setup</title> |
70 | <title>Setup</title> |
| 51 | <section> |
71 | <section> |
| 52 | <title>Setting up Portage to use Distcc</title> |
72 | <title>Dependencies</title> |
| 53 | <body> |
73 | <body> |
| 54 | <p>Setting up distcc is very easy to do with Portage. Follow these simple steps on each computer you want to use distcc on:</p> |
74 | |
| 55 | <pre caption="Integrating Distcc and Portage"> |
75 | <p> |
|
|
76 | In order to use Distcc, all of the computers on your network need to have the |
|
|
77 | same GCC versions. For example, mixing 3.3.x (where the x varies) is okay, but |
|
|
78 | mixing 3.3.x with 3.2.x <b>may</b> result in compilation errors or runtime |
|
|
79 | errors. |
|
|
80 | </p> |
|
|
81 | |
|
|
82 | </body> |
|
|
83 | </section> |
|
|
84 | <section> |
|
|
85 | <title>Installing Distcc</title> |
|
|
86 | <body> |
|
|
87 | |
|
|
88 | <p> |
|
|
89 | There are a couple of options you should be aware of before you start |
|
|
90 | installing distcc. |
|
|
91 | </p> |
|
|
92 | |
|
|
93 | <p> |
|
|
94 | Distcc ships with a graphical monitor to monitor tasks that your computer is |
|
|
95 | sending away for compilation. If you use Gnome then put 'gnome' in your USE |
|
|
96 | flags. However, if you don't use Gnome and would still like to have the |
|
|
97 | monitor then you should put 'gtk' in your USE flags. |
|
|
98 | </p> |
|
|
99 | |
|
|
100 | <pre caption="Installing distcc"> |
| 56 | # <i>emerge distcc</i> |
101 | # <i>emerge distcc</i> |
|
|
102 | </pre> |
|
|
103 | |
|
|
104 | <impo> |
|
|
105 | Remember, you must be sure to install distcc on all of your participating |
|
|
106 | machines. |
|
|
107 | </impo> |
|
|
108 | |
|
|
109 | </body> |
|
|
110 | </section> |
|
|
111 | <section> |
|
|
112 | <title>Setting up Portage to use Distcc</title> |
|
|
113 | <body> |
|
|
114 | |
|
|
115 | <p> |
|
|
116 | Setting up Portage to use distcc is easy. Execute the following steps on |
|
|
117 | each system that should participate in the distributed compiling: |
|
|
118 | </p> |
|
|
119 | |
|
|
120 | <pre caption="Integrating Distcc and Portage"> |
|
|
121 | # <i>emerge distcc distcc-config</i> |
| 57 | # <i>nano -w /etc/make.conf</i> |
122 | # <i>nano -w /etc/make.conf</i> |
| 58 | <codenote>Edit your FEATURES flags to include "distcc"</codenote> |
123 | <comment>(Set N to a suitable number for your particular setup)</comment> |
|
|
124 | <comment>(A common strategy is setting N as twice the number of total CPUs + 1 available)</comment> |
|
|
125 | MAKEOPTS="-jN" |
|
|
126 | <comment>(Add distcc to your FEATURES)</comment> |
|
|
127 | FEATURES="distcc" |
| 59 | </pre> |
128 | </pre> |
| 60 | |
129 | |
| 61 | <p>Next you have to specify what hosts you want to use. To do this you can use the <i>distcc-config</i> command to set that list of hosts. Here is an example of some hosts that might be in your list:</p> |
130 | </body> |
|
|
131 | </section> |
|
|
132 | <section> |
|
|
133 | <title>Specifying Participating Hosts</title> |
|
|
134 | <body> |
|
|
135 | |
|
|
136 | <p> |
|
|
137 | Use the <c>distcc-config</c> command to set the list of hosts. Here is an |
|
|
138 | example of some hosts that might be in your list: |
|
|
139 | </p> |
|
|
140 | |
| 62 | <pre caption="Examples of host definitions"> |
141 | <pre caption="Examples of host definitions"> |
| 63 | 192.168.0.1 192.168.0.2 192.168.0.3 |
142 | 192.168.0.1 192.168.0.2 192.168.0.3 |
| 64 | 192.168.0.1/2 192.168.0.2 192.168.0.3/10 |
143 | 192.168.0.1/2 192.168.0.2 192.168.0.3/10 |
| 65 | 192.168.0.1:4000/2 192.168.0.2/1 192.168.0.3:3632/4 |
144 | 192.168.0.1:4000/2 192.168.0.2/1 192.168.0.3:3632/4 |
| 66 | @192.168.0.1 @192.168.0.2:/usr/bin/distccd 192.168.0.3 |
145 | @192.168.0.1 @192.168.0.2:/usr/bin/distccd 192.168.0.3 |
|
|
146 | <comment>(There are also several other methods of setting up hosts. See the |
|
|
147 | distcc manpage for more details.)</comment> |
|
|
148 | <comment>If you wish to compile on the local machine you should put 'localhost' |
|
|
149 | in the hosts list. Conversely if you do not wish to use the local machine to |
|
|
150 | compile (which is often the case) omit it from the hosts list. On a slow |
|
|
151 | machine using localhost may actually slow things down. Make sure to test your |
|
|
152 | settings for performance.</comment> |
| 67 | </pre> |
153 | </pre> |
| 68 | <p>It may all look complicated, but in most cases a variant of line 1 or 2 will work. An explanation of each line is: Line 1 is just a space-delimited list of hosts that will use default everything. Line 2 is a list of hosts that specifies the maxmimum number of jobs (by use of the /N) to send that host at any given time (specified with the <c>/n</c>). Since most people won't be using lines 3 or 4, I'll <uri link="http://distcc.samba.org/man/distcc_1.html">point you to</uri> the distcc docs for more information.</p> |
154 | |
| 69 | <p>A sample command to set the hosts (for line 1) is:</p> |
155 | <p> |
|
|
156 | It may all look complicated, but in most cases a variant of line 1 or 2 will |
|
|
157 | work. |
|
|
158 | </p> |
|
|
159 | |
|
|
160 | <p> |
|
|
161 | Since most people won't be using lines 3 or 4, I'll <uri |
|
|
162 | link="http://distcc.samba.org/man/distcc_1.html">refer to</uri> the distcc |
|
|
163 | docs (man distcc) for more information. |
|
|
164 | </p> |
|
|
165 | |
|
|
166 | <p> |
|
|
167 | For instance, to set the first line in the previous example: |
|
|
168 | </p> |
|
|
169 | |
| 70 | <pre caption="Sample command to set the hosts"> |
170 | <pre caption="Sample command to set the hosts"> |
| 71 | # <i>/usr/bin/distcc-config --set-hosts "192.168.0.1 192.168.0.2 192.168.0.3</i> |
171 | # <i>/usr/bin/distcc-config --set-hosts "192.168.0.1 192.168.0.2 192.168.0.3"</i> |
| 72 | </pre> |
172 | </pre> |
| 73 | |
173 | |
| 74 | <p>The final step to integrating distcc into Portage is to re-open your <path>/etc/make.conf</path> and edit <c>MAKE_OPTS</c> to include <c>-jN</c> (where N is an integer). Typically you will want to set this to the total number of processors in your network plus one.</p> |
174 | <p> |
| 75 | <pre caption="Final steps in make.conf"> |
175 | Edit <path>/etc/conf.d/distccd</path> to your needs and be sure to set the |
|
|
176 | <c>--allow</c> directive to allow only hosts you trust. For added security, |
|
|
177 | you should also use the <c>--listen</c> directive to tell the distcc daemon |
|
|
178 | what IP to listen on (for multi-homed systems). More information on distcc |
|
|
179 | security can be found at <uri |
|
|
180 | link="http://distcc.samba.org/security.html">Distcc Security Design</uri>. |
|
|
181 | </p> |
|
|
182 | |
|
|
183 | <impo> |
|
|
184 | It is important to use --allow and --listen. Please read the distccd manpage |
|
|
185 | or the above security document for more information. |
|
|
186 | </impo> |
|
|
187 | |
|
|
188 | |
|
|
189 | <p> |
|
|
190 | Now start the distcc daemon on all the participating computers: |
|
|
191 | </p> |
|
|
192 | |
|
|
193 | <pre caption="Starting the distcc daemon"> |
|
|
194 | <comment>(Add distccd to the default runlevel)</comment> |
|
|
195 | # <i>rc-update add distccd default</i> |
|
|
196 | <comment>(Start the distcc daemon)</comment> |
|
|
197 | # <i>/etc/init.d/distccd start</i> |
|
|
198 | </pre> |
|
|
199 | |
|
|
200 | </body> |
|
|
201 | </section> |
|
|
202 | <section> |
|
|
203 | <title>Setting up Distcc to Work With Automake</title> |
|
|
204 | <body> |
|
|
205 | |
|
|
206 | <p> |
|
|
207 | This is, in some cases, easier than the Portage setup. What you have to do is |
|
|
208 | update your <c>PATH</c> variable to include <path>/usr/lib/distcc/bin</path> |
|
|
209 | in front of the directory that contains <c>gcc</c> (<path>/usr/bin</path>). |
|
|
210 | However, there is a caveat. If you use ccache you have to put distcc after |
|
|
211 | the ccache part: |
|
|
212 | </p> |
|
|
213 | |
|
|
214 | <pre caption="Setting your path"> |
|
|
215 | # <i>export PATH="/usr/lib/ccache/bin:/usr/lib/distcc/bin:${PATH}"</i> |
|
|
216 | <comment>(You can put this in your ~/.bashrc or equivalent file to have the PATH |
|
|
217 | set every time you log in)</comment> |
|
|
218 | </pre> |
|
|
219 | |
|
|
220 | <p> |
|
|
221 | Then, as you would normally type <c>make</c>, you would type <c>make -jN</c> |
|
|
222 | (where N is an integer). The value of N depends on your network and the types |
|
|
223 | of computers you are using to compile. Test your own settings to find the |
|
|
224 | number that yields the best performance. |
|
|
225 | </p> |
|
|
226 | |
|
|
227 | </body> |
|
|
228 | </section> |
|
|
229 | </chapter> |
|
|
230 | |
|
|
231 | <chapter> |
|
|
232 | <title>Cross-Compiling</title> |
|
|
233 | <section> |
|
|
234 | <body> |
|
|
235 | |
|
|
236 | <p> |
|
|
237 | Cross-compiling is using one architecture to build programs for another |
|
|
238 | architecture. This can be as simple as using an Athlon (i686) to build a |
|
|
239 | program for a K6-2 (i586), or using a Sparc to build a program for a ppc. This |
|
|
240 | is documented in our <uri link="/doc/en/cross-compiling-distcc.xml">DistCC |
|
|
241 | Cross-compiling Guide</uri>. |
|
|
242 | </p> |
|
|
243 | |
|
|
244 | </body> |
|
|
245 | </section> |
|
|
246 | </chapter> |
|
|
247 | |
|
|
248 | <chapter id="bootstrapping"> |
|
|
249 | <title>Using Distcc to Bootstrap</title> |
|
|
250 | <section> |
|
|
251 | <title>Step 1: Configure Portage</title> |
|
|
252 | <body> |
|
|
253 | <!-- |
|
|
254 | Note that this will need to become a link to the old 2005.1 networked handbooks |
|
|
255 | once the 2006.0 handbooks are released. Until then, the link can stay. |
|
|
256 | --> |
|
|
257 | <p> |
|
|
258 | Boot your new box with a Gentoo Linux LiveCD and follow the <uri |
|
|
259 | link="/doc/en/handbook/handbook-x86.xml?part=1">installation instructions</uri> |
|
|
260 | up until the bootstrapping part. (See the <uri |
|
|
261 | link="/doc/en/faq.xml#stage12">Gentoo FAQ</uri> for more information about |
|
|
262 | bootstrapping.) Then configure Portage to use distcc: |
|
|
263 | </p> |
|
|
264 | |
|
|
265 | <pre caption="Preliminary Setup"> |
| 76 | # <i>nano -w /etc/make.conf</i> |
266 | # <i>nano -w /etc/make.conf</i> |
|
|
267 | <comment>(Add distcc to the FEATURES</comment> |
|
|
268 | FEATURES="distcc" |
|
|
269 | <comment>(Modify MAKEOPTS to include -jN, where N is twice the number of CPUs |
|
|
270 | +1 available)</comment> |
| 77 | MAKE_OPTS=-jN |
271 | MAKEOPTS="-jN" |
| 78 | </pre> |
272 | </pre> |
| 79 | </body> |
273 | |
| 80 | </section> |
|
|
| 81 | <section> |
|
|
| 82 | <title>Setting up Distcc to Work With Automake</title> |
|
|
| 83 | <body> |
|
|
| 84 | <p>This is in some cases easier than the Portage setup. What you have to do is update your <c>PATH</c> envvar to include <path>/usr/lib/distcc/bin</path> before where gcc (<path>/usr/bin</path>). However, there is a caveat. If you use ccache you have to put distcc after the ccache part. Like so:</p> |
|
|
| 85 | <pre caption="Setting your path"> |
274 | <pre caption="Setting your path"> |
| 86 | # <i>export PATH="/usr/lib/ccache/bin:/usr/lib/distcc/bin:${PATH}"</i> |
275 | # <i>export PATH="/usr/lib/ccache/bin:/usr/lib/distcc/bin:${PATH}"</i> |
| 87 | </pre> |
276 | </pre> |
| 88 | <p>Then, as you would normally type <c>make</c>, you would type <c>make -jN</c> (where N is an integer). A safe number to use for N varries on your network and the types of computers you are using to compile. For me, I have a dual processor P3 and a K6-2/400 that compile everything for my desktop (a 1200MHz Athlon Thunderbird) and I use -j5. Test your own settings to find the right number.</p> |
277 | |
| 89 | </body> |
278 | </body> |
| 90 | </section> |
279 | </section> |
|
|
280 | <section> |
|
|
281 | <title>Step 2: Getting Distcc</title> |
|
|
282 | <body> |
|
|
283 | |
|
|
284 | <p> |
|
|
285 | Install distcc: |
|
|
286 | </p> |
|
|
287 | |
|
|
288 | <pre caption="Getting Distcc on the new box"> |
|
|
289 | # <i>USE='-*' emerge --nodeps sys-devel/distcc sys-devel/distcc-config</i> |
|
|
290 | </pre> |
|
|
291 | |
|
|
292 | </body> |
|
|
293 | </section> |
|
|
294 | <section> |
|
|
295 | <title>Step 3: Setting Up Distcc</title> |
|
|
296 | <body> |
|
|
297 | |
|
|
298 | <p> |
|
|
299 | Run <c>distcc-config --install</c> to setup distcc: |
|
|
300 | </p> |
|
|
301 | |
|
|
302 | <pre caption="Final distcc setup"> |
|
|
303 | <comment>(Substitute host1, host2, ... with the IP number(s) of the |
|
|
304 | participating hosts)</comment> |
|
|
305 | # <i>/usr/bin/distcc-config --set-hosts "localhost host1 host2 host3 ..."</i> |
|
|
306 | <comment>An example: <i>/usr/bin/distcc-config --set-hosts "localhost |
|
|
307 | 192.168.0.4 192.168.0.6"</i></comment> |
|
|
308 | </pre> |
|
|
309 | |
|
|
310 | <p> |
|
|
311 | Distcc is now set up to bootstrap! Continue with the official installation |
|
|
312 | instructions and <e>do not forget</e> to re-emerge distcc after <c>emerge |
|
|
313 | system</c>. This is to make sure that all of the dependencies you want are |
|
|
314 | installed as well. |
|
|
315 | </p> |
|
|
316 | |
|
|
317 | <note> |
|
|
318 | During bootstrap and <c>emerge system</c> distcc may not appear to be used. |
|
|
319 | This is expected as some ebuilds do not work well with distcc, so they |
|
|
320 | intentionally disable it. |
|
|
321 | </note> |
|
|
322 | |
|
|
323 | </body> |
|
|
324 | </section> |
| 91 | </chapter> |
325 | </chapter> |
| 92 | |
326 | |
| 93 | <chapter> |
327 | <chapter> |
| 94 | <title>Cross-Compiling</title> |
328 | <title>Troubleshooting</title> |
| 95 | <section> |
329 | <section> |
| 96 | <title>A Note on Cross-Compiling</title> |
330 | <title>Some Packages Don't Use Distcc</title> |
| 97 | <body> |
331 | <body> |
| 98 | <p>Cross-compiling is using one architecture to build programs for another architecture. This can be as simple as using an Athlon (i686) to build a program for a K6-2 (i586), or using a Sparc to build a program for a ppc.</p> |
332 | |
|
|
333 | <p> |
|
|
334 | As you emerge various packages, you'll notice that some of them aren't being |
|
|
335 | distributed (and aren't being built in parallel). This may happen because the |
|
|
336 | package's Makefile doesn't support parallel operations or the maintainer of the |
|
|
337 | ebuild has explicitly disabled parallel operations due to a known problem. |
|
|
338 | </p> |
|
|
339 | |
|
|
340 | <p> |
|
|
341 | Sometimes distcc might cause a package to fail to compile. If this happens |
|
|
342 | for you, please <uri link="http://bugs.gentoo.org">report</uri> it to us. |
|
|
343 | </p> |
|
|
344 | |
| 99 | </body> |
345 | </body> |
| 100 | </section> |
346 | </section> |
| 101 | <section> |
347 | <section> |
| 102 | <title>A Personal Note on Cross-compiling</title> |
348 | <title>Mixed GCC Versions</title> |
| 103 | <body> |
349 | <body> |
| 104 | <p>I'd love to be able to help out on the Gentoo Cross-compiling effort, but I don't have any non-x86 machines. I can create things that work <e>in theory</e>, but I have to rely on other people to test what I write. That works to an extent, but it's tough. ;-)</p> |
350 | |
| 105 | <p>In the near future I hope to acquire a Sparc of some type to put Gentoo on so I can play around in-house.</p> |
351 | <p> |
|
|
352 | If you have different GCC versions on your hosts, there will likely be very |
|
|
353 | weird problems. The solution is to make certain all hosts have the same GCC |
|
|
354 | version. |
|
|
355 | </p> |
|
|
356 | |
|
|
357 | <p> |
|
|
358 | Recent Portage updates have made Portage use <c>${CHOST}-gcc</c> instead of |
|
|
359 | <c>gcc</c>. This means that if you're mixing i686 machines with other types |
|
|
360 | (i386, i586) you will run into problems. A workaround for this may be to |
|
|
361 | <c>export CC='gcc' CXX='c++'</c> or to put it in <path>/etc/make.conf</path>. |
|
|
362 | </p> |
|
|
363 | |
|
|
364 | <impo> |
|
|
365 | Doing this explicitly redefines some behaviour of Portage and may have some |
|
|
366 | weird results in the future. Only do this if you're mixing CHOSTs. |
|
|
367 | </impo> |
|
|
368 | |
|
|
369 | |
| 106 | </body> |
370 | </body> |
| 107 | </section> |
371 | </section> |
| 108 | </chapter> |
372 | </chapter> |
| 109 | |
373 | |
| 110 | <chapter> |
374 | <chapter> |
| 111 | <title>Known Problems With Distcc</title> |
|
|
| 112 | <section> |
|
|
| 113 | <title>Portage Doesn't Work With Distcc</title> |
|
|
| 114 | <body> |
|
|
| 115 | <p>This heading is a misnomer, really. The only thing that doens't work is the monitoring programs (<c>distccmon-text</c> and <c>distccmon-gnome</c>) with the standard distcc source. The reason for this is that distcc relies on the <c>TMPDIR</c> envvar, but Portage reassigns that.</p> |
|
|
| 116 | <p>The solution to this is a patch that changes the dependancy to <c>DISTCC_TMPDIR</c>. The patch is automatically applied to distcc. If you don't want to use <path>/tmp</path> (the default) you can reassign <c>DISTCC_TMPDIR</c>.</p> |
|
|
| 117 | <p>You may also notice that Distcc does not work with some packages. This can be a result of several things, such as an error in the .ebuild (Using <c>make</c> instead of <c>emake</c>) or an error in the program's Makefile, which the next section addresses.</p> |
|
|
| 118 | </body> |
|
|
| 119 | </section> |
|
|
| 120 | <section> |
|
|
| 121 | <title>Mozilla and Xfree</title> |
|
|
| 122 | <body> |
|
|
| 123 | <p>As you emerge various packages, you'll notice that they aren't being distributed (and indeed aren't being built in parallel). This is because the developers of Mozilla and Xfree .ebuilds disabled parallel building because it is known to cause problems. This isn't necessarily a distcc problem.</p> |
|
|
| 124 | <p>That isn't to say that sometimes distcc will cause a package to fail to compile.</p> |
|
|
| 125 | </body> |
|
|
| 126 | </section> |
|
|
| 127 | </chapter> |
|
|
| 128 | |
|
|
| 129 | <chapter> |
|
|
| 130 | <title>Using Distcc to Bootstrap</title> |
|
|
| 131 | <section> |
|
|
| 132 | <title>Step 1: Build the Tarball</title> |
|
|
| 133 | <body> |
|
|
| 134 | <p>This section is helpful if you want to use Distcc during the Gentoo installation. Surprisingly it isn't that hard. What you'll need is another computer running Gentoo and a way to transfer a tarball to your new system (I use scp).</p> |
|
|
| 135 | <p>First you have to build a tarball of Distcc and include a library (<c>/usr/lib/libpopt.so.*</c>).</p> |
|
|
| 136 | <pre caption="Building the tarball"> |
|
|
| 137 | <i># USE='-gtk -selinux' emerge --buildpkg distcc |
|
|
| 138 | # mkdir -p /tmp/distcc/usr/lib |
|
|
| 139 | # cp /usr/portage/packages/sys-devel/distcc-DISTCC_VERSION.tbz2 /tmp/distcc/ |
|
|
| 140 | # cp /usr/lib/libpopt.so.* /tmp/distcc/usr/lib |
|
|
| 141 | # cd /tmp/distcc |
|
|
| 142 | # tar cfzv distcc.tar.gz *</i> |
|
|
| 143 | <codenote>Be sure you replace DISTCC_VERSION with the version (and Gentoo revision) of Distcc, <c>like 2.10-r1</c></codenote> |
|
|
| 144 | </pre> |
|
|
| 145 | </body> |
|
|
| 146 | </section> |
|
|
| 147 | <section> |
|
|
| 148 | <title>Step 2: Setup on New Box</title> |
|
|
| 149 | <body> |
|
|
| 150 | <impo>Do not forget to start sshd and reset the root password for the LiveCD!</impo> |
|
|
| 151 | <p>Next, you have to boot your new box with a Gentoo Linux LiveCD and follow all of the steps up until the bootstrapping. Then procede with a little preliminary setup on the new box.</p> |
|
|
| 152 | <pre caption="Preliminary Setup"> |
|
|
| 153 | <codenote>Here we add distcc to FEATURES</codenote> |
|
|
| 154 | <i># echo "FEATURES=\"\${FEATURES} distcc\"" >> /etc/make.conf</i> |
|
|
| 155 | <codenote>You can also use <c>nano</c> to edit <c>/etc/make.conf</c> and manually add distcc to FEATURES.</codenote> |
|
|
| 156 | <i># echo "MAKEOPTS=\"\${MAKEOPTS} -jN\"" >> /etc/make.conf</i> |
|
|
| 157 | <codenote>Just like above, you can use <c>nano</c> to edit <c>/etc/make.conf</c> and manually change MAKEOPTS.</codenote> |
|
|
| 158 | </pre> |
|
|
| 159 | <p>Then add the distcc user to your <c>/etc/passwd</c>:</p> |
|
|
| 160 | <pre caption="Add the distcc user to /etc/passwd"> |
|
|
| 161 | <i># echo "distcc:x:240:2:distccd:/dev/null:/bin/false" >>/etc/passwd</i> |
|
|
| 162 | <codenote>Do not forget the `<c>>></c>'</codenote> |
|
|
| 163 | </pre> |
|
|
| 164 | </body> |
|
|
| 165 | </section> |
|
|
| 166 | <section> |
|
|
| 167 | <title>Step 3: Copy the Tarball</title> |
|
|
| 168 | <body> |
|
|
| 169 | <p>Next you will want to copy the distcc tarball that you made.</p> |
|
|
| 170 | <pre caption="Copy the tarball to the new box"> |
|
|
| 171 | <codenote>Execute this on the "old" box</codenote> |
|
|
| 172 | <i># scp /tmp/distcc/distcc.tar.gz root@ip.of.new.box:/mnt/gentoo/</i> |
|
|
| 173 | <codenote>Substitute <c>ip.of.new.box</c> for your new box's IP</codenote> |
|
|
| 174 | </pre> |
|
|
| 175 | </body> |
|
|
| 176 | </section> |
|
|
| 177 | |
|
|
| 178 | <section> |
|
|
| 179 | <title>Step 4: Unpacking the Tarball</title> |
|
|
| 180 | <body> |
|
|
| 181 | <pre caption="Unpack the tarball"> |
|
|
| 182 | <i># tar xvfz distcc.tar.gz |
|
|
| 183 | # tar xvfjp distcc-DISTCC_VERSION.tbz2</i> |
|
|
| 184 | <codenote>Be sure you replace DISTCC_VERSION with the version (and Gentoo revision) of Distcc, <c>like 2.10-r1</c></codenote> |
|
|
| 185 | </pre> |
|
|
| 186 | </body> |
|
|
| 187 | </section> |
|
|
| 188 | |
|
|
| 189 | <section> |
|
|
| 190 | <title>Step 5: Setting Up Distcc Itself</title> |
|
|
| 191 | <body> |
|
|
| 192 | <p>Now set up distcc itself...</p> |
|
|
| 193 | <pre caption="Final distcc setup"> |
|
|
| 194 | <i># /usr/bin/distcc-config --install |
|
|
| 195 | # /usr/bin/distcc-config --set-hosts "localhost host1 host2 host3 ..."</i> |
|
|
| 196 | </pre> |
|
|
| 197 | |
|
|
| 198 | <p>distcc should be set up now to bootstrap! Continue the official install guide, and dont forget to re-emerge distcc after <c>emerge system</c>.</p> |
|
|
| 199 | </body> |
|
|
| 200 | </section> |
|
|
| 201 | </chapter> |
|
|
| 202 | |
|
|
| 203 | |
|
|
| 204 | <chapter> |
|
|
| 205 | <title>Distcc Extras</title> |
375 | <title>Distcc Extras</title> |
| 206 | <section> |
376 | <section> |
| 207 | <title>Distcc Monitors</title> |
377 | <title>Distcc Monitors</title> |
| 208 | <body> |
378 | <body> |
| 209 | <p>Distcc ships with two monitors. The text-based one is always built, it is called <c>distccmon-text</c>. Running it for the first time can be a bit confusing, but it is really quite easy to use. If you run the program with no parameter it will run once. However, if you pass it a number it will update every N seconds, where N is the argument you passed.</p> |
379 | |
| 210 | <p>The other monitor is only turned on if you enabled <c>gtk</c> in your <c>USE</c> flags. This one is GTK+ based and runs in an X environment, and it is quite lovely.</p> |
380 | <p> |
| 211 | <p>There is a caveat to using these programs. If you want to monitor any emerge, you have to start the monitor like so:</p> |
381 | Distcc ships with two monitors. The text-based one is always built and is |
|
|
382 | called <c>distccmon-text</c>. Running it for the first time can be a bit |
|
|
383 | confusing, but it is really quite easy to use. If you run the program with no |
|
|
384 | parameter it will run once. However, if you pass it a number it will update |
|
|
385 | every N seconds, where N is the argument you passed. |
|
|
386 | </p> |
|
|
387 | |
|
|
388 | <p> |
|
|
389 | The other monitor is only turned on if you enabled <c>gtk</c> or <c>gnome</c> |
|
|
390 | in your <c>USE</c> flags. This one is GTK+ based, runs in an X environment |
|
|
391 | and it is quite lovely. For Gentoo the GUI monitor has been called |
|
|
392 | <c>distccmon-gui</c> for less confusion. Elsewhere it may be referred to as |
|
|
393 | <c>distccmon-gnome</c>. |
|
|
394 | </p> |
|
|
395 | |
| 212 | <pre caption="Starting the monitors"> |
396 | <pre caption="Starting the monitors"> |
| 213 | <i>sudo -u portage distccmon-text N</i> |
397 | # <i>distccmon-text N</i> |
| 214 | <codenote>Or you can start the graphical monitor...</codenote> |
398 | <comment>(Or)</comment> |
| 215 | <i>sudo -u portage distccmon-gnome</i> |
399 | # <i>distccmon-gui</i> |
| 216 | <note>If you aren't using <c>userpriv</c> in your FEATURES, you should not use the '-u portage' part.</note> |
400 | <comment>To monitor Portage's distcc usage you can use:</comment> |
|
|
401 | # <i>DISTCC_DIR="/var/tmp/portage/.distcc/" distccmon-text N</i> |
|
|
402 | <comment>(Or)</comment> |
|
|
403 | # <i>DISTCC_DIR="/var/tmp/portage/.distcc/" distccmon-gui</i> |
| 217 | </pre> |
404 | </pre> |
|
|
405 | |
|
|
406 | <impo> |
|
|
407 | If your distcc directory is elsewhere, change the DISTCC_DIR variable |
|
|
408 | accordingly. |
|
|
409 | </impo> |
|
|
410 | |
| 218 | </body> |
411 | </body> |
| 219 | </section> |
412 | </section> |
| 220 | </chapter> |
|
|
| 221 | |
|
|
| 222 | <chapter> |
413 | </chapter> |
| 223 | <title>Future Plans for Distcc and Gentoo</title> |
|
|
| 224 | <section> |
|
|
| 225 | <title>distcc-subnetscan</title> |
|
|
| 226 | <body> |
|
|
| 227 | <p><c>distcc-subnetscan</c> is a perl program in development that will scan a subnet for hosts that have a participating distcc daemon. Even this will be enhanced to test if the daemon on a remote host will conform to a specific <c>CHOST</c> setting to make cross-compiling easier.</p> |
|
|
| 228 | <p>The perl script is being kept at <uri link="http://dev.gentoo.org/~lisa/distcc/distcc-subnetscan/distcc-subnetscan.pl">right here</uri> until a more formal home can be found.</p> |
|
|
| 229 | </body> |
|
|
| 230 | </section> |
|
|
| 231 | <section> |
|
|
| 232 | <title>distcc-config</title> |
|
|
| 233 | <body> |
|
|
| 234 | <p><c>distcc-config</c>, the userland configuration tool for distcc is out of date. Soon it will be rewritten to be brought up the current version of distcc.</p> |
|
|
| 235 | </body> |
|
|
| 236 | </section> |
|
|
| 237 | </chapter> |
|
|
| 238 | |
|
|
| 239 | </guide> |
414 | </guide> |