Skip to content

[rtsan][NFC] Add 'known to have non-deterministic' caveat to documentation #114281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2024

Conversation

cjappl
Copy link
Contributor

@cjappl cjappl commented Oct 30, 2024

As suggested by @fmayer in #113979

@llvmbot llvmbot added the clang Clang issues not falling into any other category label Oct 30, 2024
@llvmbot
Copy link
Member

llvmbot commented Oct 30, 2024

@llvm/pr-subscribers-clang

Author: Chris Apple (cjappl)

Changes

As suggested by @fmayer in #113979


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

1 Files Affected:

  • (modified) clang/docs/RealtimeSanitizer.rst (+2-2)
diff --git a/clang/docs/RealtimeSanitizer.rst b/clang/docs/RealtimeSanitizer.rst
index e5f5abfcd9b47e..193f5217c1a1a1 100644
--- a/clang/docs/RealtimeSanitizer.rst
+++ b/clang/docs/RealtimeSanitizer.rst
@@ -12,9 +12,9 @@ projects. RTSan can be used to detect real-time violations, i.e. calls to method
 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. At run-time, if RTSan detects a call to ``malloc``, 
-``free``, ``pthread_mutex_lock``, or anything else that could have a 
+``free``, ``pthread_mutex_lock``, or anything else known to have a 
 non-deterministic execution time in a function marked ``[[clang::nonblocking]]``
-RTSan raises an error.
+it raises an error. 
 
 RTSan performs its analysis at run-time but shares the ``[[clang::nonblocking]]`` 
 attribute with the :doc:`FunctionEffectAnalysis` system, which operates at 

@cjappl
Copy link
Contributor Author

cjappl commented Oct 30, 2024

(doc build failure is unrelated, I will rebase after approval and make sure that passes):

Warning, treated as error:
/home/runner/work/llvm-project/llvm-project/clang-build/tools/clang/docs/index.rst:89:toctree contains reference to nonexisting document 'ClangFormattedStatus'

@cjappl
Copy link
Contributor Author

cjappl commented Oct 30, 2024

Build failures tracked to #109220

@cjappl
Copy link
Contributor Author

cjappl commented Oct 31, 2024

#114331 has been merged, so the test failure is fixed. Going to save the build machine a workout and submit without a rebase, as this change is very unlikely to cause any problems

@cjappl cjappl merged commit 880b3b2 into llvm:main Oct 31, 2024
10 of 11 checks passed
smallp-o-p pushed a commit to smallp-o-p/llvm-project that referenced this pull request Nov 3, 2024
NoumanAmir657 pushed a commit to NoumanAmir657/llvm-project that referenced this pull request Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clang Clang issues not falling into any other category
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants