[NFC] [docs] point users towards clang remark flags #147820
Merged
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
Created using spr 1.3.4
fhahn
reviewed
Jul 9, 2025
llvm/docs/Remarks.rst
Outdated
| There are two modes that are supported for enabling optimization remarks in | ||
| LLVM: through remark diagnostics, or through serialized remarks. | ||
|
|
||
| See also the clang flags `-Rpass` and `-fsave-optimization-record`. |
Contributor
There was a problem hiding this comment.
Is it possible to link to/ cross-reference the clang docs here?
fhahn
approved these changes
Jul 10, 2025
| LLVM: through remark diagnostics, or through serialized remarks. | ||
|
|
||
| See also the clang flags | ||
| `-Rpass <https://clang.llvm.org/docs/UsersManual.html#options-to-emit-optimization-reports>`_ |
Contributor
There was a problem hiding this comment.
Is it possible to directly reference the sections via RST, so we don't hard-code them? This would avoid potentially having them broken in the future.
If not, that should be fine.
Contributor
Author
There was a problem hiding this comment.
I don't know, to be honest.
Contributor
Author
There was a problem hiding this comment.
(The problem is that this is in the LLVM RST, while the target is in the clang. They are hosted on separate subdomains, so I am not sure how that would work)
fmayer
deleted the
users/fmayer/spr/nfc-docs-point-users-towards-clang-remark-flags
branch
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.
No description provided.