Skip to content

Updating the Rust compiler used by Servo

larsbergstrom edited this page Nov 13, 2014 · 22 revisions

The Rust compiler is prebuilt for Servo, targeting our main host platforms (OSX and Linux), each targeting both the native host platform and Android.

Prebuilding a Rust compiler

To create a new cached Rust compiler:

  1. Fetch the latest upstream changes

    git fetch upstream
    
  2. Create a branch with the hash of the Rust commit you are interested in:

    git checkout 0935beba717bf6d3b54ad1b2eace359dea5dfca0
    
  3. Build with cross-compilation enabled. Linux (MUST have GLIBC version 2.17 installed locally!):

    ./configure --host=x86_64-unknown-linux-gnu,i686-unknown-linux-gnu --target=x86_64-unknown-linux-gnu,i686-unknown-linux-gnu,arm-linux-androideabi --android-cross-path=/home/larsberg/ndk-standalone && make clean ; make -j4 rustc-stage2 && make dist
    

OSX: ./configure --target=x86_64-apple-darwin,i686-apple-darwin,arm-linux-androideabi --android-cross-path=/Users/larsberg/ndk-standalone/ && make clean ; make -j4 rustc-stage2 && make dist

  1. Upload the binary produced to the s3 bucket:
    s3cmd put dist/rust-* s3://servo-rust/0935beba717bf6d3b54ad1b2eace359dea5dfca0/
    

Updating the Rust compiler version used in Servo

Once a build has been uploaded, the SHA of the head commit from our Rust fork needs to be entered into the file src/compiler/rust-snapshot-hash/. A subsequent run of the configure script will pull down the new compiler from our S3 bucket and use that instead of the old one.

Updating submodules

Servo's submodules fall into two categories:

  1. Libraries maintained by the servo team. For these projects, the main development "trunk" is the master branch in the servo/<project> repo, and this is also the branch used in Servo builds.

  2. Libraries with a separate upstream maintainer. For these projects, the Servo team maintains a fork at servo/<project> with a servo branch. This is the branch used in Servo builds, and it may also contain Servo-specific changes (e.g. changes that are not yet accepted upstream, or that are not useful outside of the Servo build system). The servo fork should not contain a master branch, since that branch is not used by the Servo team and could cause confusion if it is out of sync with the servo branch or the upstream master branch.

When upgrading Servo to a new version of Rust, use the following steps to update each submodule:

  1. Merge any changes from the upstream repo (if there is one) into the servo repo's servo branch—except for changes that require a newer version of Rust than the one Servo is upgrading to.

  2. For each submodule that needs further patches to work with the new Rust version, create a new branch named rustup_<date> in the servo fork of the submodule. For example, rustup_20140508.

  3. Push any required changes to the rustup_* branch. When ready, submit a pull request to the upstream repo for any changes that apply to upstream (if there is one). Then submit a pull request to the servo repo to merge the same changes, plus any Servo-specific changes. (If there is no separate upstream, just submit a single pull request to the master branch in the servo repo.)

  4. After the changes are reviewed and merged, update the Rust upgrade branch in the servo repo to point to the new head of the servo or master branch in the servo/<project> repo.

Clone this wiki locally