From 672d721544f4793a20f8c9565bb0808e9991694d Mon Sep 17 00:00:00 2001 From: DQ Date: Sun, 3 Jul 2022 11:32:36 +0200 Subject: [PATCH 1/2] Clarify `-Zmiri-track-pointer-tag` to explicitly say it also tracks tag creation --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4681a3d38214..dc297115fa1b 100644 --- a/README.md +++ b/README.md @@ -383,8 +383,8 @@ to Miri failing to detect cases of undefined behavior in a program. Borrows "protectors". Specifying this argument multiple times does not overwrite the previous values, instead it appends its values to the list. Listing an id multiple times has no effect. * `-Zmiri-track-pointer-tag=,,...` shows a backtrace when a given pointer tag - is popped from a borrow stack (which is where the tag becomes invalid and any - future use of it will error). This helps you in finding out why UB is + is created or when it is popped from a borrow stack (which is where the tag becomes invalid + and any future use of it will error). This helps you in finding out why UB is happening and where in your code would be a good place to look for it. Specifying this argument multiple times does not overwrite the previous values, instead it appends its values to the list. Listing a tag multiple times has no effect. From 1b9e19a39b8f884e4a85011d25641e8bc3480288 Mon Sep 17 00:00:00 2001 From: DQ Date: Sun, 3 Jul 2022 15:47:39 +0200 Subject: [PATCH 2/2] clarify that a (tracked) tag may never be popped Co-authored-by: Ralf Jung --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dc297115fa1b..787952b9d746 100644 --- a/README.md +++ b/README.md @@ -383,7 +383,7 @@ to Miri failing to detect cases of undefined behavior in a program. Borrows "protectors". Specifying this argument multiple times does not overwrite the previous values, instead it appends its values to the list. Listing an id multiple times has no effect. * `-Zmiri-track-pointer-tag=,,...` shows a backtrace when a given pointer tag - is created or when it is popped from a borrow stack (which is where the tag becomes invalid + is created and when (if ever) it is popped from a borrow stack (which is where the tag becomes invalid and any future use of it will error). This helps you in finding out why UB is happening and where in your code would be a good place to look for it. Specifying this argument multiple times does not overwrite the previous