From c847f2442e6cb9a3350237fe7b595a8c3682d2f4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=AE=B8=E6=9D=B0=E5=8F=8B=20Jieyou=20Xu=20=28Joe=29?=
 <39484203+jieyouxu@users.noreply.github.com>
Date: Wed, 25 Sep 2024 01:46:42 +0800
Subject: [PATCH] Note lldb debuginfo requires `python310.dll` to be present in
 `PATH`

---
 src/tests/compiletest.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/tests/compiletest.md b/src/tests/compiletest.md
index 1b506d350..4ba2f0cc5 100644
--- a/src/tests/compiletest.md
+++ b/src/tests/compiletest.md
@@ -254,6 +254,17 @@ test based on the debugger currently being used:
   NOTE: The "Rust" version of LLDB doesn't exist anymore, so this will always be ignored.
   This should probably be removed.
 
+> **Note on running lldb debuginfo tests locally**
+>
+> If you want to run lldb debuginfo tests locally, then currently on Windows it is required that:
+> 
+> - You have **exactly** Python 3.10 installed -- not a newer version, not an older version,
+>   precisely 3.10.
+> - You have the `python310.dll` available in your `PATH` env var. This is not provided by the
+>   standard Python installer you obtain from `python.org`; you need to add this to `PATH` manually.
+> 
+> Otherwise the lldb debuginfo tests can produce crashes in mysterious ways.
+
 [`tests/debuginfo`]: https://github.com/rust-lang/rust/tree/master/tests/debuginfo