[llvm] [NFC] Fix #106873 - update assignment tracking docs (PR #106959)

Orlando Cazalet-Hyams via llvm-commits llvm-commits at lists.llvm.org
Mon Sep 2 02:49:04 PDT 2024


https://github.com/OCHyams created https://github.com/llvm/llvm-project/pull/106959

None

>From 027e25b4641d80a0b3cfeb6f604be50cdcd9a1e3 Mon Sep 17 00:00:00 2001
From: Orlando Cazalet-Hyams <orlando.hyams at sony.com>
Date: Mon, 2 Sep 2024 10:48:01 +0100
Subject: [PATCH] [NFC] Fix #106873 - update assignment tracking docs

---
 llvm/docs/AssignmentTracking.md | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/llvm/docs/AssignmentTracking.md b/llvm/docs/AssignmentTracking.md
index a24a8b0d797f87..e9e03e7028d0fb 100644
--- a/llvm/docs/AssignmentTracking.md
+++ b/llvm/docs/AssignmentTracking.md
@@ -20,12 +20,14 @@ LLVM pass writers, and minimal disruption to LLVM in general.
 
 ## Status and usage
 
-**Status**: Experimental work in progress. Enabling is strongly advised against
-except for development and testing.
+**Status**: Enabled by default in Clang but disabled under some circumstances
+(which can be overridden with the `forced` option, see below). `opt` will not
+run the pass unless asked (`-passes=declare-to-assign`).
 
-**Enable in Clang**: `-Xclang -fexperimental-assignment-tracking`
+**Flag**:
+`-Xclang -fexperimental-assignment-tracking=<disabled|enabled|forced>`
 
-That causes Clang to get LLVM to run the pass `declare-to-assign`. The pass
+When enabled Clang gets LLVM to run the pass `declare-to-assign`. The pass
 converts conventional debug records to assignment tracking metadata and sets
 the module flag `debug-info-assignment-tracking` to the value `i1 true`. To
 check whether assignment tracking is enabled for a module call



More information about the llvm-commits mailing list