Skip to content

Commit d43c2e7

Browse files
committed
distcheck: document what distcheck is intended to exercise
1 parent d76fe15 commit d43c2e7

File tree

2 files changed

+20
-1
lines changed
  • src
    • bootstrap/src/core/build_steps
    • ci/docker/host-x86_64/x86_64-gnu-distcheck

2 files changed

+20
-1
lines changed

src/bootstrap/src/core/build_steps/test.rs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2964,7 +2964,14 @@ impl Step for Distcheck {
29642964
run.builder.ensure(Distcheck);
29652965
}
29662966

2967-
/// Runs "distcheck", a 'make check' from a tarball
2967+
/// Runs `distcheck`, which is a collection of smoke tests:
2968+
///
2969+
/// - Run `make check` from an unpacked dist tarball to make sure we can at the minimum run
2970+
/// check steps from those sources.
2971+
/// - Check that selected dist components (`rust-src` only at the moment) at least have expected
2972+
/// directory shape and crate manifests that cargo can generate a lockfile from.
2973+
///
2974+
/// FIXME(#136822): dist components are under-tested.
29682975
fn run(self, builder: &Builder<'_>) {
29692976
builder.info("Distcheck");
29702977
let dir = builder.tempdir().join("distcheck");

src/ci/docker/host-x86_64/x86_64-gnu-distcheck/Dockerfile

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
# Runs `distcheck`, which is a collection of smoke tests:
2+
#
3+
# - Run `make check` from an unpacked dist tarball to make sure we can at the
4+
# minimum run check steps from those sources.
5+
# - Check that selected dist components at least have expected directory shape
6+
# and crate manifests that cargo can generate a lockfile from.
7+
#
8+
# Refer to `src/bootstrap/src/core/build_steps/test.rs` `Distcheck::run` for
9+
# specifics.
10+
#
11+
# FIXME(#136822): dist components are generally under-tested.
12+
113
FROM ubuntu:22.04
214

315
ARG DEBIAN_FRONTEND=noninteractive

0 commit comments

Comments
 (0)