From: Todd Lyons Date: Mon, 2 Jun 2014 13:00:58 +0000 (-0700) Subject: Add download links to packages required for building docs. X-Git-Url: https://git.exim.org/buildfarm-client-wiki.git/commitdiff_plain/544fb01b1ad620c79feba7dbe8cf80f6e80655c5?hp=9ba472b344b17e52d5bbf98913ac23b9c86abe6f Add download links to packages required for building docs. --- diff --git a/Installation.md b/Installation.md index 4fc1b3c..0b96b99 100644 --- a/Installation.md +++ b/Installation.md @@ -3,7 +3,7 @@ So you want to give back to the Exim project but don't know how? Being a member This Installation page works on the assumption that you have already submitted your [Exim BuildFarm Application](http://eximbuild.mrball.net/cgi-bin/register-form.pl) and the BuildFarm administration has sent you an email with your machine alias (aka _animal_) and secret password, which you will enter in step 9 below. If you just want to run the build farm client and never submit the results, you call simply run everything with the --test option and it will still work. If you ever run it without --test, it will still work, but the server will reject the feedback because it's from an unknown _animal_. -If you want to run more than one instance of the build farm to test multiple different configurations, such as one with OpenSSL and one with GnuTLS, simply start at step 9. More details on the extra configuration required to keep it separate from the main build are at the end of this page. +If you want to run more than one instance of the build farm to test multiple different configurations, such as one with OpenSSL and one with GnuTLS, for each subsequent animal simply start at step 9. More details on the extra configuration required to keep it separate from the main build are at the end of this page. ## Install Steps 1. Make sure that all required packages for Exim to build successfully are installed. The minimal package requirements are the basic suite of compiler tools and basic libraries. You will also need to install the ccache package. @@ -28,7 +28,7 @@ This will create the repo checkout in the directory *~/code/*. 13. Test the configure process by running `./run_build.pl --test --verbose=2 --only-steps=configure`. If there are errors, you'll need to correct them until the process succeeds (ends with OK). You can repeat this as many times as necessary because test mode does not store the status of the git repo or the status of each stage of the build. 14. Test the build process by running `./run_build.pl --test --verbose=2 --only-steps=configure,make`. If there are build errors, make adjustments, install additional packages, etc, and repeat the test. 15. Test the test suite by running `./run_build.pl --test --verbose=2 --only-steps=configure,make,test --override range_num_tests='1 2'`. If there are build errors when building the test suite, or runtime errors trying to run the test suite, you may need to install additional packages (you shouldn't though). -16. If you enabled the documentation building process in the *build-farm.conf*, then you can try to build it with `./run_build.pl --test --verbose=2 --only-steps=configure,make-doc`. For documentation generation to succeed, it will require extra packages to be installed to support xml, xslt, pdf, and a few other things. +16. If you enabled the documentation building process in the *build-farm.conf*, then you can try to build it with `./run_build.pl --test --verbose=2 --only-steps=configure,make-doc`. For documentation generation to succeed, it will require extra packages to be installed to support xml, xslt, pdf, and a few other things. You will need to install packages named **xfpt** and **sdop**. Some prebuilt packages are available for [CentOS 6](http://www.blafasel.at/exim/doc_rpms/) and [CentOS 5](http://downloads.mrball.net/Linux/CentOS/5/RPMS/x86_64/). The packages are available directly on Debian and Ubuntu distros. 17. If you can get past each of these steps, then your build farm system meets the minimum requirements. 18. The official process can be kicked off by running `/home/farm/code/run_cron.sh --run-all`. This will run the default build configuration, keep track of the git repository status, and upload the build results to the server. 19. Once that command runs with no complaints, add it to the **farm** user crontab. You can run it at whatever frequency you choose, I suggest 1 hour. If a previous instantiation is still running, the script will detect the lockfile and exit so as not to step on each other.