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.
rust-lang · Dec 6, 2019 · 3c14f0e · 3c14f0e
1 parent 9630dbb
commit 3c14f0e
Showing 1 changed file with 7 additions and 0 deletions.
diff --git 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