| 1 | <?xml version='1.0' encoding="UTF-8"?> |
1 | <?xml version='1.0' encoding="UTF-8"?> |
| 2 | <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
2 | <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 3 | <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/distcc.xml,v 1.8 2003/10/11 17:21:58 swift 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 Seelye</mail> |
10 | <mail link="lisa@gentoo.org">Lisa Seelye</mail> |
| 11 | </author> |
11 | </author> |
| 12 | |
|
|
| 13 | <author title="Editor"> |
12 | <author title="Editor"> |
| 14 | <mail link="vapier@gentoo.org">Mike Frysinger</mail> |
13 | <mail link="vapier@gentoo.org">Mike Frysinger</mail> |
| 15 | </author> |
14 | </author> |
| 16 | |
|
|
| 17 | <author title="Editor"> |
15 | <author title="Editor"> |
| 18 | <mail link="erwin@gentoo.org">Erwin</mail> |
16 | <mail link="erwin@gentoo.org">Erwin</mail> |
| 19 | </author> |
17 | </author> |
| 20 | |
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> |
| 21 | <author title="Reviewer"> |
24 | <author title="Reviewer"> |
| 22 | <mail link="swift@gentoo.org">Sven Vermeulen</mail> |
|
|
| 23 | </author> |
|
|
| 24 | |
|
|
| 25 | <author title="Reviewer"> |
|
|
| 26 | <mail link="blubber@gentoo.org">Tiemo Kieft</mail> |
25 | <mail link="blubber@gentoo.org">Tiemo Kieft</mail> |
| 27 | </author> |
26 | </author> |
| 28 | |
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 --> |
| 29 | <license/> |
34 | <license/> |
| 30 | |
35 | |
| 31 | <version>1.2.3</version> |
36 | <version>1.19</version> |
| 32 | <date>October 11, 2003</date> |
37 | <date>2007-06-22</date> |
| 33 | |
|
|
| 34 | <abstract>This document serves as a HOWTO for using distcc with Gentoo.</abstract> |
|
|
| 35 | |
38 | |
| 36 | <chapter> |
39 | <chapter> |
| 37 | <title>Introduction</title> |
40 | <title>Introduction</title> |
| 38 | <section> |
41 | <section> |
| 39 | <title>What is distcc?</title> |
42 | <title>What is distcc?</title> |
| 40 | <body> |
43 | <body> |
| 41 | <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 | |
| 42 | </body> |
53 | </body> |
| 43 | </section> |
54 | </section> |
|
|
55 | <section> |
|
|
56 | <title>Using distcc to bootstrap</title> |
|
|
57 | <body> |
|
|
58 | |
|
|
59 | <p> |
|
|
60 | If you are planning on using distcc to help you bootstrap a Gentoo |
|
|
61 | installation, make sure you read the section <uri link="#bootstrapping">Using |
|
|
62 | distcc to Bootstrap</uri>, which is situated further down in this document. |
|
|
63 | </p> |
|
|
64 | |
|
|
65 | </body> |
|
|
66 | </section> |
| 44 | </chapter> |
67 | </chapter> |
| 45 | |
68 | |
| 46 | <chapter> |
69 | <chapter> |
| 47 | <title>Setup</title> |
70 | <title>Setup</title> |
| 48 | <section> |
71 | <section> |
| 49 | <title>Dependencies</title> |
72 | <title>Dependencies</title> |
| 50 | <body> |
73 | <body> |
| 51 | <pre caption="Distcc dependencies (2.8 through 2.10)"> |
74 | |
| 52 | >=sys-apps/portage-2.0.46-r11 |
75 | <p> |
| 53 | <codenote>Distcc-2.11 and on require >=sys-apps/portage-2.0.49-r6</codenote> |
76 | In order to use Distcc, all of the computers on your network need to have the |
| 54 | >=sys-devel/gcc-config-1.3.1 |
77 | same GCC versions. For example, mixing 3.3.x (where the x varies) is okay, but |
| 55 | sys-apps/shadow |
78 | mixing 3.3.x with 3.2.x <b>may</b> result in compilation errors or runtime |
| 56 | <codenote>(As of version 2.8 and up until 2.11) And the following optional dependencies when you have <i>gtk</i> in your <i>USE</i> flags</codenote> |
79 | errors. |
| 57 | >=x11-libs/gtk+-2.2.1 |
|
|
| 58 | </pre> |
80 | </p> |
| 59 | <pre caption="Distcc Dependencies (post 2.11.1)"> |
81 | |
| 60 | >=sys-apps/portage-2.0.49-r6 |
|
|
| 61 | >=sys-devel/gcc-config-1.3.1 |
|
|
| 62 | sys-apps/shadow |
|
|
| 63 | <codenote>In this revision you may chose between a Gnome and GTK GUI monitor, they have the following added dependencies</codenote> |
|
|
| 64 | <codenote>For GTK:</codenote> |
|
|
| 65 | >=x11-libs/gtk+-2.0.0 |
|
|
| 66 | >=gnome-base/libglade-2.0.0 |
|
|
| 67 | x11-libs/pango |
|
|
| 68 | <codenote>For Gnome:</codenote> |
|
|
| 69 | >=x11-libs/gtk+-2.0.0 |
|
|
| 70 | >=gnome-base/libglade-2.0.0 |
|
|
| 71 | x11-libs/pango |
|
|
| 72 | >=gnome-base/libgnomeui-2.0.0.0 |
|
|
| 73 | >=gnome-base/libgnome-2.0.0 |
|
|
| 74 | </pre> |
|
|
| 75 | </body> |
|
|
| 76 | </section> |
|
|
| 77 | <section> |
|
|
| 78 | <title>Installing Distcc</title> |
|
|
| 79 | <body> |
|
|
| 80 | <p>Installing Distcc is very easy. Simply set your USE flags and <i>emerge distcc</i>. But, there's a couple of options you should know about.</p> |
|
|
| 81 | <p>Distcc ships with a graphical monitor to monitor tasks that your computer is sending away for compilation. If you use Gnome then put 'gnome' in your USE flags. However, if you don't use Gnome and would still like to have the monitor then you should put 'gtk' in your USE flags.</p> |
|
|
| 82 | </body> |
82 | </body> |
| 83 | </section> |
83 | </section> |
| 84 | <section> |
84 | <section> |
| 85 | <title>Setting up Portage to use Distcc</title> |
85 | <title>Installing Distcc</title> |
| 86 | <body> |
86 | <body> |
| 87 | <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> |
87 | |
| 88 | <pre caption="Integrating Distcc and Portage"> |
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"> |
| 89 | # <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> |
| 90 | # <i>nano -w /etc/make.conf</i> |
122 | # <i>nano -w /etc/make.conf</i> |
|
|
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" |
|
|
128 | </pre> |
|
|
129 | |
|
|
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: |
| 91 | </pre> |
139 | </p> |
| 92 | <impo>If you use distcc-2.11.1 or greater with >=portage-2.0.49-r6, then all you need to do as far as setup is to set your hosts (see next code block), modify MAKEOPTS in <path>/etc/make.conf</path>, and add 'distcc' to FEATURES in <path>/etc/make.conf</path>.</impo> |
|
|
| 93 | <note>Edit your FEATURES flags to include "distcc"</note> |
|
|
| 94 | <note>You should also uncomment the DISTCC_TMPDIR line in <path>/etc/make.conf</path>.</note> |
|
|
| 95 | <note>Set <i>DISTCC_DIR=${PORTAGE_TMPDIR}/portage/.distcc</i> near the end of the file (last line is okay)</note> |
|
|
| 96 | |
140 | |
| 97 | <p>Next you have to specify what hosts you want to use. To do this you can use the <c>distcc-config</c> command to set the list of hosts. Here is an example of some hosts that might be in your list:</p> |
|
|
| 98 | <pre caption="Examples of host definitions"> |
141 | <pre caption="Examples of host definitions"> |
| 99 | 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 |
| 100 | 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 |
| 101 | 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 |
| 102 | @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> |
|
|
153 | </pre> |
|
|
154 | |
|
|
155 | <p> |
|
|
156 | It may all look complicated, but in most cases a variant of line 1 or 2 will |
|
|
157 | work. |
| 103 | </pre> |
158 | </p> |
| 104 | <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 maximum 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> |
159 | |
| 105 | <p>A sample command to set the hosts (for line 1) is:</p> |
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 | |
| 106 | <pre caption="Sample command to set the hosts"> |
170 | <pre caption="Sample command to set the hosts"> |
| 107 | # <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> |
| 108 | </pre> |
172 | </pre> |
| 109 | |
173 | |
| 110 | <p>The final step to integrating distcc into Portage is to re-open your <path>/etc/make.conf</path> and edit <c>MAKEOPTS</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> |
| 111 | <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"> |
| 112 | # <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> |
| 113 | MAKEOPTS=-jN |
271 | MAKEOPTS="-jN" |
| 114 | </pre> |
272 | </pre> |
| 115 | <impo>Don't forget to start the distcc daemon! <c>/etc/init.d/distccd start</c></impo> |
273 | |
| 116 | </body> |
|
|
| 117 | </section> |
|
|
| 118 | <section> |
|
|
| 119 | <title>Setting up Distcc to Work With Automake</title> |
|
|
| 120 | <body> |
|
|
| 121 | <p>This is in some cases easier than the Portage setup. What you have to do is update your <c>PATH</c> environmental variable 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> |
|
|
| 122 | <pre caption="Setting your path"> |
274 | <pre caption="Setting your path"> |
| 123 | # <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> |
| 124 | </pre> |
276 | </pre> |
| 125 | <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 varies 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 | |
| 126 | </body> |
278 | </body> |
| 127 | </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> |
| 128 | </chapter> |
325 | </chapter> |
| 129 | |
326 | |
| 130 | <chapter> |
327 | <chapter> |
| 131 | <title>Cross-Compiling</title> |
328 | <title>Troubleshooting</title> |
| 132 | <section> |
329 | <section> |
| 133 | <title>A Note on Cross-Compiling</title> |
330 | <title>Some Packages Don't Use Distcc</title> |
| 134 | <body> |
331 | <body> |
| 135 | <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 | |
| 136 | </body> |
345 | </body> |
| 137 | </section> |
346 | </section> |
| 138 | <section> |
347 | <section> |
| 139 | <title>A Personal Note on Cross-compiling</title> |
348 | <title>Mixed GCC Versions</title> |
| 140 | <body> |
349 | <body> |
| 141 | <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 | |
| 142 | <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 | |
| 143 | </body> |
370 | </body> |
| 144 | </section> |
371 | </section> |
| 145 | </chapter> |
372 | </chapter> |
| 146 | |
373 | |
| 147 | <chapter> |
374 | <chapter> |
| 148 | <title>Using Distcc to Bootstrap</title> |
|
|
| 149 | <section> |
|
|
| 150 | <title>Step 1: Setup on New Box</title> |
|
|
| 151 | <body> |
|
|
| 152 | <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 proceed with a little preliminary setup on the new box.</p> |
|
|
| 153 | <pre caption="Preliminary Setup"> |
|
|
| 154 | <codenote>Here we add distcc to FEATURES</codenote> |
|
|
| 155 | # <i>nano -w /etc/make.conf</i> |
|
|
| 156 | <codenote>Add "distcc" to FEATURES</codenote> |
|
|
| 157 | <codenote>Modify MAKEOPTS in <path>/etc/make.conf to include -jN (as described above)</path></codenote> |
|
|
| 158 | </pre> |
|
|
| 159 | <p>Then add the distcc user to your <path>/etc/passwd</path>:</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 `<i>>></i>'</codenote> |
|
|
| 163 | </pre> |
|
|
| 164 | </body> |
|
|
| 165 | </section> |
|
|
| 166 | <section> |
|
|
| 167 | <title>Step 2: Getting Distcc</title> |
|
|
| 168 | <body> |
|
|
| 169 | <p>Next you will want to issue the following command inside the chroot on the new box.</p> |
|
|
| 170 | <pre caption="Getting Distcc on the new box"> |
|
|
| 171 | # <i>emerge --nodeps distcc</i> |
|
|
| 172 | </pre> |
|
|
| 173 | </body> |
|
|
| 174 | </section> |
|
|
| 175 | <section> |
|
|
| 176 | <title>Step 3: Setting Up Distcc Itself</title> |
|
|
| 177 | <body> |
|
|
| 178 | <p>Now set up distcc itself...</p> |
|
|
| 179 | <pre caption="Final distcc setup"> |
|
|
| 180 | # <i>/usr/bin/distcc-config --install</i> |
|
|
| 181 | # <i>/usr/bin/distcc-config --set-hosts "localhost host1 host2 host3 ..."</i> |
|
|
| 182 | </pre> |
|
|
| 183 | <p>distcc should be set up now to bootstrap! Continue the official install guide, and don't forget to re-emerge distcc after <c>emerge system</c>.</p> |
|
|
| 184 | </body> |
|
|
| 185 | </section> |
|
|
| 186 | </chapter> |
|
|
| 187 | |
|
|
| 188 | <chapter> |
|
|
| 189 | <title>Troubleshooting</title> |
|
|
| 190 | <section> |
|
|
| 191 | <title>Mozilla and Xfree</title> |
|
|
| 192 | <body> |
|
|
| 193 | <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> |
|
|
| 194 | <p>That isn't to say that sometimes distcc will cause a package to fail to compile.</p> |
|
|
| 195 | </body> |
|
|
| 196 | </section> |
|
|
| 197 | <section> |
|
|
| 198 | <title>A Mixture of hardened-gcc and non-hardened-gcc Hosts Will Be Faulty</title> |
|
|
| 199 | <body> |
|
|
| 200 | <p>With such a long title any explanation here is almost irrelevent. However, if you plan to use distcc across hosts that have the <uri link="http://www.gentoo.org/proj/en/hardened/etdyn-ssp.xml">PaX/hardened-gcc</uri> and some that do not, you will run into problems.</p> |
|
|
| 201 | <p>The solution requires a little foresight on your part; you have to run <c>hardened-gcc -R</c> on the host that has PaX/hardened-gcc, or you have to enable PaX protections in your kernel and <c>emerge hardened-gcc</c>. Both of which are a good thing to do since for the most part the protections offered by both packages is a good thing and is transparent to the user.</p> |
|
|
| 202 | </body> |
|
|
| 203 | </section> |
|
|
| 204 | <section> |
|
|
| 205 | <title>Mixed GCC Versions</title> |
|
|
| 206 | <body> |
|
|
| 207 | <p>If you have differing versions of GCC on your hosts, there will likely be very weird problems. The solution is to make certain all hosts have the same GCC version.</p> |
|
|
| 208 | </body> |
|
|
| 209 | </section> |
|
|
| 210 | </chapter> |
|
|
| 211 | |
|
|
| 212 | <chapter> |
|
|
| 213 | <title>Distcc Extras</title> |
375 | <title>Distcc Extras</title> |
| 214 | <section> |
376 | <section> |
| 215 | <title>Distcc Monitors</title> |
377 | <title>Distcc Monitors</title> |
| 216 | <body> |
378 | <body> |
| 217 | <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 | |
| 218 | <p>The other monitor is only turned on if you enabled <c>gtk</c> or <c>gnome</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> |
| 219 | <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 | |
| 220 | <pre caption="Starting the monitors"> |
396 | <pre caption="Starting the monitors"> |
|
|
397 | # <i>distccmon-text N</i> |
|
|
398 | <comment>(Or)</comment> |
|
|
399 | # <i>distccmon-gui</i> |
|
|
400 | <comment>To monitor Portage's distcc usage you can use:</comment> |
| 221 | # <i>DISTCC_DIR=/path/to/distccdir distccmon-text N</i> |
401 | # <i>DISTCC_DIR="/var/tmp/portage/.distcc/" distccmon-text N</i> |
| 222 | <codenote>Or you can start the graphical monitor...</codenote> |
402 | <comment>(Or)</comment> |
| 223 | # <i>DISTCC_DIR=/path/to/distccdir distccmon-gnome</i> |
403 | # <i>DISTCC_DIR="/var/tmp/portage/.distcc/" distccmon-gui</i> |
| 224 | </pre> |
404 | </pre> |
| 225 | <impo>If you are using Portage and used the above example, this will be <c>DISTCC_DIR=/var/tmp/portage/.distcc</c>.</impo> |
405 | |
| 226 | <note>If you aren't using Portage you do not need to specify DISTCC_DIR (i.e., just type distccmon-text N).</note> |
406 | <impo> |
|
|
407 | If your distcc directory is elsewhere, change the DISTCC_DIR variable |
|
|
408 | accordingly. |
|
|
409 | </impo> |
|
|
410 | |
| 227 | </body> |
411 | </body> |
| 228 | </section> |
412 | </section> |
| 229 | </chapter> |
|
|
| 230 | |
|
|
| 231 | <chapter> |
413 | </chapter> |
| 232 | <title>Future Plans for Distcc and Gentoo</title> |
|
|
| 233 | <section> |
|
|
| 234 | <title>distcc-subnetscan</title> |
|
|
| 235 | <body> |
|
|
| 236 | <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> |
|
|
| 237 | <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> |
|
|
| 238 | </body> |
|
|
| 239 | </section> |
|
|
| 240 | <section> |
|
|
| 241 | <title>distcc-config</title> |
|
|
| 242 | <body> |
|
|
| 243 | <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> |
|
|
| 244 | </body> |
|
|
| 245 | </section> |
|
|
| 246 | </chapter> |
|
|
| 247 | |
|
|
| 248 | </guide> |
414 | </guide> |