smithj 05/07/01 22:42:42 Modified: xml/htdocs/doc/en distcc.xml Log: #42712: coding style cleanup and fix for some technical errors
Revision Changes Path 1.28 +61 -45 xml/htdocs/doc/en/distcc.xml file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/distcc.xml?rev=1.28&content-type=text/x-cvsweb-markup&cvsroot=gentoo plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/distcc.xml?rev=1.28&content-type=text/plain&cvsroot=gentoo diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/distcc.xml.diff?r1=1.27&r2=1.28&cvsroot=gentoo Index: distcc.xml =================================================================== RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/distcc.xml,v retrieving revision 1.27 retrieving revision 1.28 diff -u -r1.27 -r1.28 --- distcc.xml 1 Jul 2005 22:35:19 -0000 1.27 +++ distcc.xml 1 Jul 2005 22:42:42 -0000 1.28 @@ -1,6 +1,6 @@ <?xml version='1.0' encoding="UTF-8"?> <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/distcc.xml,v 1.27 2005/07/01 22:35:19 smithj Exp $ --> +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/distcc.xml,v 1.28 2005/07/01 22:42:42 smithj Exp $ --> <guide link="/doc/en/distcc.xml"> @@ -38,8 +38,8 @@ <!-- See http://creativecommons.org/licenses/by-sa/1.0 --> <license/> -<version>1.11</version> -<date>2005-03-25</date> +<version>1.13</version> +<date>2005-07-01</date> <chapter> <title>Introduction</title> @@ -51,7 +51,8 @@ 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 work. +link="http://ccache.samba.org";>ccache</uri>, Portage, and Automake with a +little setup. </p> </body> @@ -61,9 +62,9 @@ <body> <p> -If you are planning on using distcc to help you bootstrap a Gentoo installation, -make sure you read the section <uri link="#bootstrapping">Using distcc to -Bootstrap</uri>, which is situated further down in this document. +If you are planning on using distcc to help you bootstrap a Gentoo +installation, make sure you read the section <uri link="#bootstrapping">Using +distcc to Bootstrap</uri>, which is situated further down in this document. </p> </body> @@ -77,9 +78,10 @@ <body> <p> -In order to use Distcc, all of the computers on your network need to -have the same GCC versions. Mixing 3.3.x (where the x varies) is okay, but -mixing 3.3.x and 3.2.x <b>will</b> result in your programs having errors in them. +In order to use Distcc, all of the computers on your network need to have the +same GCC versions. For example, mixing 3.3.x (where the x varies) is okay, but +mixing 3.3.x with 3.2.x <b>may</b> result in compilation errors or runtime +errors. </p> </body> @@ -119,9 +121,10 @@ # <i>emerge distcc</i> # <i>nano -w /etc/make.conf</i> <comment>(Set N to a suitable number for your particular setup)</comment> -<comment>(A common heuristic strategy is twice the number of total CPUs + 1)</comment> +<comment>(A common strategy is setting N as twice the number of total CPUs + 1 +available)</comment> MAKEOPTS="-jN" -<comment>(Add distcc to your FEATURES variable)</comment> +<comment>(Add distcc to your FEATURES)</comment> FEATURES="distcc" </pre> @@ -132,8 +135,8 @@ <body> <p> -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: +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> <pre caption="Examples of host definitions"> @@ -143,6 +146,11 @@ @192.168.0.1 @192.168.0.2:/usr/bin/distccd 192.168.0.3 <comment>(There are also several other methods of setting up hosts. See the distcc manpage for more details.)</comment> +<comment>If you wish to compile on the local machine you should put 'localhost' +in the hosts list. Conversely if you do not wish to use the local machine to +compile (which is often the case) omit it from the hosts list. On a slow +machine using localhost may actually slow things down. Make sure to test your +settings for performance.</comment> </pre> <p> @@ -150,18 +158,10 @@ work. </p> -<ul> - <li>Line 1 is just a space-delimited list of hosts</li> - <li> - Line 2 is a list of hosts that specifies the maximum amount of jobs (by - defining the <c>/N</c> setting) to send that host at any given time - </li> -</ul> - <p> 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. +link="http://distcc.samba.org/man/distcc_1.html";>refer to</uri> the distcc +docs (man distcc) for more information. </p> <p> @@ -174,12 +174,19 @@ <p> Edit <path>/etc/conf.d/distccd</path> to your needs and be sure to set the -<c>--allow</c> directive to allow only hosts you trust. For added security, you should also use the <c>--listen</c> -directive to tell the distcc daemon what IP to listen on (for multi-homed -systems). More information on distcc security can be found at <uri link="http://distcc.samba.org/security.html";>Distcc Security -Design</uri>. +<c>--allow</c> directive to allow only hosts you trust. For added security, +you should also use the <c>--listen</c> directive to tell the distcc daemon +what IP to listen on (for multi-homed systems). More information on distcc +security can be found at <uri +link="http://distcc.samba.org/security.html";>Distcc Security Design</uri>. </p> +<impo> +It is important to use --allow and --listen. Please read the distccd manpage +or the above seurity document for more information. +</impo> + + <p> Now start the distcc daemon on all the participating computers: </p> @@ -207,15 +214,15 @@ <pre caption="Setting your path"> # <i>export PATH="/usr/lib/ccache/bin:/usr/lib/distcc/bin:${PATH}"</i> +<comment>You can put this in your .bashrc or equivelant file to have the PATH +set every time you log in</comment> </pre> <p> Then, as you would normally type <c>make</c>, you would type <c>make -jN</c> (where N is an integer). The value of N depends 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 compiles everything for my desktop (a 1200MHz Athlon -Thunderbird) and I use -j5. Test your own settings to find the number that -yields the best performance. +of computers you are using to compile. Test your own settings to find the +number that yields the best performance. </p> </body> @@ -264,9 +271,10 @@ <pre caption="Preliminary Setup"> # <i>nano -w /etc/make.conf</i> -<comment>(Add distcc to the FEATURES variable)</comment> +<comment>(Add distcc to the FEATURES</comment> FEATURES="distcc" -<comment>(Modify MAKEOPTS to include -jN with N an appropriate integer)</comment> +<comment>(Modify MAKEOPTS to include -jN, where N is twice the number of CPUs ++1 available)</comment> MAKEOPTS="-jN" </pre> @@ -286,7 +294,7 @@ </p> <pre caption="Create user distcc"> -# <i>echo "distcc:x:240:2:distccd:/dev/null:/bin/false" >> /etc/passwd</i> +# <i>echo "distcc:x:240:2:distccd:/dev/null:/bin/false" >>/etc/passwd</i> </pre> <impo> @@ -314,9 +322,11 @@ </p> <pre caption="Final distcc setup"> -<comment>(Substitute host1, host2, ... with the IP number(s) of the participating hosts)</comment> +<comment>(Substitute host1, host2, ... with the IP number(s) of the +participating hosts)</comment> # <i>/usr/bin/distcc-config --set-hosts "localhost host1 host2 host3 ..."</i> -<comment>An example: <i>/usr/bin/distcc-config --set-hosts "localhost 192.168.0.4 192.168.0.6"</i></comment> +<comment>An example: <i>/usr/bin/distcc-config --set-hosts "localhost +192.168.0.4 192.168.0.6"</i></comment> </pre> -- [email protected] mailing list
