[clang][ThreadSafety] Fix code block syntax in ThreadSafetyAnalysis.rst #96494
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Without a newline, documentation was failing to build with this error:
Warning, treated as error:
/home/runner/work/llvm-project/llvm-project/clang-build/tools/clang/docs/ThreadSafetyAnalysis.rst:466:Error in "code-block" directive:
maximum 1 argument(s) allowed, 10 supplied.
Issue llvm#92408
|
@llvm/pr-subscribers-clang Author: Dan McArdle (dmcardle) ChangesWithout a newline, documentation was failing to build with this error: Issue #92408 Full diff: https://github.com/llvm/llvm-project/pull/96494.diff 1 Files Affected:
diff --git a/clang/docs/ThreadSafetyAnalysis.rst b/clang/docs/ThreadSafetyAnalysis.rst
index 0ecbebe7a692f..1513719caa464 100644
--- a/clang/docs/ThreadSafetyAnalysis.rst
+++ b/clang/docs/ThreadSafetyAnalysis.rst
@@ -464,6 +464,7 @@ on success and ``LockNotAcquired`` on failure, the analysis may fail to detect
access to guarded data without holding the mutex because they are both non-zero.
.. code-block:: c++
+
// *** Beware: this code demonstrates incorrect usage. ***
enum TrylockResult { LockAcquired = 1, LockNotAcquired = 2 };
|
|
@AaronBallman PTAL — looks like #95290 broke the documentation. |
AaronBallman
approved these changes
Jun 24, 2024
dmcardle
added a commit
to dmcardle/llvm-project
that referenced
this pull request
Jul 1, 2024
…alysis.rst (llvm#96494)" This reverts commit 3402620.
AaronBallman
pushed a commit
that referenced
this pull request
Jul 1, 2024
…97293) This PR reverts #95290 and the one-liner followup PR #96494. I received some substantial feedback on #95290, which I plan to address in a future PR. I've also received feedback that because the change emits errors where they were not emitted before, we should at least have a flag to disable the stricter warnings.
lravenclaw
pushed a commit
to lravenclaw/llvm-project
that referenced
this pull request
Jul 3, 2024
…lvm#97293) This PR reverts llvm#95290 and the one-liner followup PR llvm#96494. I received some substantial feedback on llvm#95290, which I plan to address in a future PR. I've also received feedback that because the change emits errors where they were not emitted before, we should at least have a flag to disable the stricter warnings.
kbluck
pushed a commit
to kbluck/llvm-project
that referenced
this pull request
Jul 6, 2024
…lvm#97293) This PR reverts llvm#95290 and the one-liner followup PR llvm#96494. I received some substantial feedback on llvm#95290, which I plan to address in a future PR. I've also received feedback that because the change emits errors where they were not emitted before, we should at least have a flag to disable the stricter warnings.
AlexisPerry
pushed a commit
to llvm-project-tlp/llvm-project
that referenced
this pull request
Jul 9, 2024
…st (llvm#96494) Without a newline, documentation was failing to build with this error: Warning, treated as error: /home/runner/work/llvm-project/llvm-project/clang-build/tools/clang/docs/ThreadSafetyAnalysis.rst:466:Error in "code-block" directive: maximum 1 argument(s) allowed, 10 supplied. Issue llvm#92408
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Without a newline, documentation was failing to build with this error:
Issue #92408