Skip to content

[clang][docs] fix rendering of $-prefixed options #119249

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
Dec 9, 2024

Conversation

carlocab
Copy link
Member

@carlocab carlocab commented Dec 9, 2024

This was added in #117573 but the options were not being rendered
correctly due to the missing newline after ::.

This was added in llvm#117573 but the options were not being rendered
correctly due to the missing newline after `::`.
@carlocab carlocab requested a review from pawosm-arm December 9, 2024 19:12
@llvmbot llvmbot added the clang Clang issues not falling into any other category label Dec 9, 2024
@llvmbot
Copy link
Member

llvmbot commented Dec 9, 2024

@llvm/pr-subscribers-clang

Author: Carlo Cabrera (carlocab)

Changes

This was added in #117573 but the options were not being rendered
correctly due to the missing newline after ::.


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

1 Files Affected:

  • (modified) clang/docs/UsersManual.rst (+1)
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst
index 5b7a293a4ecc27..8af9f5be644a02 100644
--- a/clang/docs/UsersManual.rst
+++ b/clang/docs/UsersManual.rst
@@ -1066,6 +1066,7 @@ is being invoked, and added after all of the command-line specified linker
 inputs. Here is some example of ``$``-prefixed options:
 
 ::
+
     $-Wl,-Bstatic $-lm
     $-Wl,-Bshared
 

Copy link
Contributor

@pawosm-arm pawosm-arm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gosh, sorry for the confusion it caused. LGTM.

@carlocab
Copy link
Member Author

carlocab commented Dec 9, 2024

No worries, I missed it too. For future reference, it might be useful to check the rich diff too:

Screenshot 2024-12-10 at 3 23 35 AM

@carlocab carlocab merged commit 511e84f into llvm:main Dec 9, 2024
8 of 10 checks passed
@carlocab carlocab deleted the config-option-rendering branch December 9, 2024 19:24
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