rust-lang / rust-lang/rustc-dev-guide

Document how to build rustc under the same conditions as in CI

Open
#447 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

A-contribution-workflows A-contributor-devex C-CI E-hard T-compiler T-infra
Dominant language
HTML
Stars
1.9k
Forks
613
Avg merge
17h 24m
Merged PRs (30d)
39

Description

Sometimes the CI build fails, and when one tries running it locally, it succeeds.

@mati865 mentions here that one can build locally on linux under the same conditions as CI by doing:

DEPLOY=1 ./src/ci/docker/run.sh dist-x86_64-linux.

This other user had to use this instead:

#!/bin/bash

# Clean up from previous build
rm -rf build

# Configuration which is always enabled
export RUST_RELEASE_CHANNEL=nightly
RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --enable-sccache"
RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --disable-manage-submodules"
RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --enable-locked-deps"
RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --enable-cargo-native-static"
RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --set rust.codegen-units-std=1"

# Deploy configuration
RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --release-channel=$RUST_RELEASE_CHANNEL"
RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --enable-llvm-static-stdcpp"
RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --set rust.remap-debuginfo"
RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --debuginfo-level-std=1"

RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --enable-llvm-assertions"
RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --set rust.verify-llvm-ir"

RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --enable-debug-assertions"
RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --set rust.jemalloc"

# Configure and make
./configure $RUST_CONFIGURE_ARGS
make -j $(nproc)

we should document exactly how to try to reproduce a CI failure locally inside docker, and then how to try to reproduce it outside docker but still using all other options that are set in CI but not by default (like using jemalloc instead of the system allocator).

This information should be complemented with a fix to #443 that explains how to attach a debugger on these scenarios.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/ci/docker/run.sh and the documented ./configure and make commands in the issue, then compare them with the CI configuration to identify options not enabled by default. Done means documenting both Docker-based reproduction and an outside-Docker reproduction using the relevant CI options, with debugger guidance coordinated with #443.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, rust
Domain
build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.