[rtsan][NFC] Add documentation link to Function Effects

[cjappl]

No description provided.

[llvmbot]

@llvm/pr-subscribers-clang

Author: Chris Apple (cjappl)

Changes

---

Full diff: https://github.com/llvm/llvm-project/pull/113979.diff

1 Files Affected:

• (modified) clang/docs/RealtimeSanitizer.rst (+8-3)

diff --git a/clang/docs/RealtimeSanitizer.rst b/clang/docs/RealtimeSanitizer.rst
index 41b8bbb33baf14..e5f5abfcd9b47e 100644
--- a/clang/docs/RealtimeSanitizer.rst
+++ b/clang/docs/RealtimeSanitizer.rst
@@ -11,11 +11,16 @@ RealtimeSanitizer (a.k.a. RTSan) is a real-time safety testing tool for C and C+
 projects. RTSan can be used to detect real-time violations, i.e. calls to methods
 that are not safe for use in functions with deterministic run time requirements.
 RTSan considers any function marked with the ``[[clang::nonblocking]]`` attribute
-to be a real-time function. If RTSan detects a call to ``malloc``, ``free``,
-``pthread_mutex_lock``, or anything else that could have a non-deterministic
-execution time in a function marked ``[[clang::nonblocking]]``
+to be a real-time function. At run-time, if RTSan detects a call to ``malloc``, 
+``free``, ``pthread_mutex_lock``, or anything else that could have a 
+non-deterministic execution time in a function marked ``[[clang::nonblocking]]``
 RTSan raises an error.
 
+RTSan performs its analysis at run-time but shares the ``[[clang::nonblocking]]`` 
+attribute with the :doc:`FunctionEffectAnalysis` system, which operates at 
+compile-time to detect potential real-time safety violations. For comprehensive 
+detection of real-time safety issues, it is recommended to use both systems together.
+
 The runtime slowdown introduced by RealtimeSanitizer is negligible.
 
 How to build

[cjappl]

CC for review @dougsonos

[Sirraide]

Effects paragraph lgtm. I’m not really familiar w/ rtsan, so I can’t comment on the rest.

[dougsonos]

LGTM