Skip to content

Conversation

ojhunt
Copy link
Contributor

@ojhunt ojhunt commented Aug 28, 2025

No description provided.

@llvmbot llvmbot added the clang Clang issues not falling into any other category label Aug 28, 2025
@ojhunt ojhunt self-assigned this Aug 28, 2025
@llvmbot
Copy link
Member

llvmbot commented Aug 28, 2025

@llvm/pr-subscribers-clang

Author: Oliver Hunt (ojhunt)

Changes

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

1 Files Affected:

  • (modified) clang/docs/index.rst (+1)
diff --git a/clang/docs/index.rst b/clang/docs/index.rst
index 542bfc94cd576..be654af57f890 100644
--- a/clang/docs/index.rst
+++ b/clang/docs/index.rst
@@ -45,6 +45,7 @@ Using Clang as a Compiler
    BoundsSafetyImplPlans
    ControlFlowIntegrity
    LTOVisibility
+   PointerAuthentication
    SafeStack
    ShadowCallStack
    SourceBasedCodeCoverage

@ojhunt
Copy link
Contributor Author

ojhunt commented Aug 28, 2025

In a true miracle of editing prowess I did not actually add the pointer authentication docs to the content page \o/

Seriously not sure what section this should be in - This seems like a question for @AaronBallman or @kbeyls ?

@ojhunt ojhunt requested review from AaronBallman and kbeyls August 28, 2025 06:41
@ojhunt ojhunt changed the title Add pointer auth documentation to content Add pointer auth documentation to contents Aug 28, 2025
@kbeyls
Copy link
Collaborator

kbeyls commented Aug 28, 2025

I think this looks good.

I'm assuming that "user documentation" goes under the heading "Using Clang as a Compiler", which this PR does.

I observe that there is also a section "Design Documents". I think that the pointer authentication documentation is much closer to "user documentation" than to "Design Documents", so I agree with the section you put it in, @ojhunt .

It's easy to move it later to another section if another section would be better.

@ojhunt
Copy link
Contributor Author

ojhunt commented Aug 28, 2025

Checked with Aaron and he feels this is ok :D

@ojhunt ojhunt merged commit 6394c58 into main Aug 28, 2025
12 checks passed
@ojhunt ojhunt deleted the users/ojhunt/include-ptrauth-docs-in-content branch August 28, 2025 21:02
@ojhunt
Copy link
Contributor Author

ojhunt commented Aug 29, 2025

/cherry-pick 6394c58

@llvmbot
Copy link
Member

llvmbot commented Aug 29, 2025

/cherry-pick 6394c58

Error: Command failed due to missing milestone.

@ojhunt
Copy link
Contributor Author

ojhunt commented Aug 29, 2025

/cherry-pick 6394c58

@llvmbot
Copy link
Member

llvmbot commented Aug 29, 2025

/pull-request #155954

@llvmbot llvmbot moved this from Needs Triage to Done in LLVM Release Status Aug 29, 2025
@ojhunt
Copy link
Contributor Author

ojhunt commented Aug 29, 2025

(oh yay, you don't have to create a separate issue \o/ )

tru pushed a commit to llvmbot/llvm-project that referenced this pull request Sep 3, 2025
I cleverly hid the pointer authentication documentation by not adding it to the documentation contents.

(cherry picked from commit 6394c58)
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
Development

Successfully merging this pull request may close these issues.

3 participants