| 1 | = Using Icecream with QtWebKit = |
| 2 | |
| 3 | This guide will help you through setting up the Icecream distributed |
| 4 | compilation suite on your Ubuntu workstation. |
| 5 | |
| 6 | This guide assumes that you are working in a heterogeneous build environment |
| 7 | where multiple people are running different versions of their distribution than the rest of the team. |
| 8 | |
| 9 | == Host Setup == |
| 10 | |
| 11 | Start by installing the `icecc` package as `root`: |
| 12 | |
| 13 | {{{ |
| 14 | $ apt-get install icecc |
| 15 | }}} |
| 16 | |
| 17 | If you are interested in monitoring your compilation jobs, you can also install |
| 18 | the `icemon` package. |
| 19 | |
| 20 | '''Note:''' If you want to trick your teammates into contributing to the |
| 21 | build-farm, well-knowing that they have no interest in using the build-farm |
| 22 | themselves, just convince them to install the `icecc` package and ensure that |
| 23 | the daemon is running on their machines. |
| 24 | |
| 25 | === Scheduler === |
| 26 | |
| 27 | One computer in your network will have to run a scheduler-daemon for the |
| 28 | build-farm. This does not have to be a fast machine and the scheduler can run |
| 29 | on a machine that participates in the compilation jobs as well. |
| 30 | |
| 31 | To start the scheduler during boot, open the `/etc/default/icecc` file and |
| 32 | ensure that the file contains the following: |
| 33 | |
| 34 | {{{ |
| 35 | START_ICECC="true" |
| 36 | START_ICECC_SCHEDULER="true" |
| 37 | }}} |
| 38 | |
| 39 | Remember to restart the `icecc` service before the change will take effect: |
| 40 | |
| 41 | {{{ |
| 42 | $ sudo /etc/init.d/icecc restart |
| 43 | }}} |
| 44 | |
| 45 | === Using your Native Compiler on Remote Machines === |
| 46 | |
| 47 | `icecc` supports using a packed down version of your local compiler on the other machines participating in the build-farm. |
| 48 | |
| 49 | To generate such package, run: |
| 50 | |
| 51 | {{{ |
| 52 | $ icecc --build-native |
| 53 | }}} |
| 54 | |
| 55 | The `.tar.gz` file it generates has an MD5 sum as name and it is generally |
| 56 | considered to be a good idea to keep that name to avoid collisions when the |
| 57 | file is distributed out to your teammates computers. |
| 58 | |
| 59 | To make `icecc` your newly created package, run: |
| 60 | |
| 61 | {{{ |
| 62 | $ export ICECC_VERSION="/path/to/md5sum.tar.gz" |
| 63 | }}} |
| 64 | |
| 65 | == Scratchbox Setup == |
| 66 | |
| 67 | First of all, ensure that icecc is working correctly on your host setup before |
| 68 | you start trying to get it working in Scratchbox. |
| 69 | |
| 70 | == Caveats == |
| 71 | |
| 72 | Here are my debugging hints that I used when I tried to get this up and |
| 73 | running. |
| 74 | |
| 75 | === Getting Debug Output from `icecc` === |
| 76 | |
| 77 | If you want to figure out what is going on with `icecc`, during builds, try the following: |
| 78 | |
| 79 | {{{ |
| 80 | $ export ICECC_DEBUG="debug" |
| 81 | }}} |
| 82 | |
| 83 | This will make `icecc` write what it is currently doing and you will be able to |
| 84 | identify which compilers are being executed on the various machines in your |
| 85 | compilation cluster. |