Skip to content

Conversation

@RamNalamothu
Copy link
Contributor

Fix typo in shadow call stack option name mentioned in 'ShadowCallStack.rst'.

@RamNalamothu RamNalamothu requested a review from jaidTw July 31, 2025 08:55
@llvmbot llvmbot added the clang Clang issues not falling into any other category label Jul 31, 2025
@llvmbot
Copy link
Member

llvmbot commented Jul 31, 2025

@llvm/pr-subscribers-clang

Author: Venkata Ramanaiah Nalamothu (RamNalamothu)

Changes

Fix typo in shadow call stack option name mentioned in 'ShadowCallStack.rst'.


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

1 Files Affected:

  • (modified) clang/docs/ShadowCallStack.rst (+1-1)
diff --git a/clang/docs/ShadowCallStack.rst b/clang/docs/ShadowCallStack.rst
index fc8bea83e1145..9b104cc3b7180 100644
--- a/clang/docs/ShadowCallStack.rst
+++ b/clang/docs/ShadowCallStack.rst
@@ -61,7 +61,7 @@ The instrumentation makes use of the platform register ``x18`` on AArch64,
 ``x3`` (``gp``) on RISC-V with software shadow stack and ``ssp`` on RISC-V with
 hardware shadow stack, which needs `Zicfiss`_ and ``-fcf-protection=return``.
 Users can choose between the software and hardware based shadow stack
-implementation on RISC-V backend by passing ``-fsanitize=shadowcallstack``
+implementation on RISC-V backend by passing ``-fsanitize=shadow-call-stack``
 or ``Zicfiss`` with ``-fcf-protection=return``.
 For simplicity we will refer to this as the ``SCSReg``. On some platforms,
 ``SCSReg`` is reserved, and on others, it is designated as a scratch register.

Copy link
Contributor

@jaidTw jaidTw left a comment

Choose a reason for hiding this comment

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

LGTM

@RamNalamothu RamNalamothu merged commit 523b4b0 into llvm:main Jul 31, 2025
12 checks passed
@RamNalamothu RamNalamothu deleted the scs-doc-fix branch July 31, 2025 16:02
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