about summary refs log tree commit diff
diff options
context:
space:
mode:
authorAaron Hill <aa1ronham@gmail.com>2019-12-06 16:38:57 -0500
committerGitHub <noreply@github.com>2019-12-06 16:38:57 -0500
commit3c14f0eaa7eafb1a61dab61fc37c11c3e450cba2 (patch)
tree9396aac6bce2065bef3083844b7132a90ed2db5a
parent9630dbbc3caca60f2482e6eae8904aa6bda54f93 (diff)
downloadrust-3c14f0eaa7eafb1a61dab61fc37c11c3e450cba2.tar.gz
rust-3c14f0eaa7eafb1a61dab61fc37c11c3e450cba2.zip
Add note to src/ci/docker/README.md about multiple docker images
I spent a while debugging a strage linker error about an outdated `glibc` version, only to discover that it was caused by a stale `obj` directory. It wasn't obviously to be that using the same obj dir with multiple Docker images (for the same target triple) could be a problem.

This commit adds a note to the README, which should hopefully be helpful to anyone else who runs into this issue.
-rw-r--r--src/ci/docker/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/ci/docker/README.md b/src/ci/docker/README.md
index a2d83eca24b..872f2c3467d 100644
--- a/src/ci/docker/README.md
+++ b/src/ci/docker/README.md
@@ -16,6 +16,13 @@ for example:
 
 Images will output artifacts in an `obj` dir at the root of a repository.
 
+**NOTE**: Re-using the same `obj` dir with different docker images with
+the same target triple (e.g. `dist-x86_64-linux` and `dist-various-1`)
+may result in strange linker errors, due shared library versions differing between platforms.
+
+If you encounter any issues when using multiple Docker images, try deleting your `obj` directory
+before running your command.
+
 ## Filesystem layout
 
 - Each directory, excluding `scripts` and `disabled`, corresponds to a docker image