Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Duplicate documentation entry for {no_,}randomize_layout #133706

Closed
qbojj opened this issue Mar 31, 2025 · 5 comments · Fixed by #134089
Closed

Duplicate documentation entry for {no_,}randomize_layout #133706

qbojj opened this issue Mar 31, 2025 · 5 comments · Fixed by #134089
Assignees
Labels
clang Clang issues not falling into any other category documentation good first issue https://github.com/llvm/llvm-project/contribute

Comments

@qbojj
Copy link
Contributor

qbojj commented Mar 31, 2025

https://clang.llvm.org/docs/AttributeReference.html#randomize-layout-no-randomize-layout
and the following entry are (almost) the same.

The only difference is that the first table is for no_randomize_layout and the next is for randomize_layout.

@dtcxzyw dtcxzyw added documentation good first issue https://github.com/llvm/llvm-project/contribute and removed new issue labels Mar 31, 2025
@llvmbot
Copy link
Member

llvmbot commented Mar 31, 2025

Hi!

This issue may be a good introductory issue for people new to working on LLVM. If you would like to work on this issue, your first steps are:

  1. Check that no other contributor has already been assigned to this issue. If you believe that no one is actually working on it despite an assignment, ping the person. After one week without a response, the assignee may be changed.
  2. In the comments of this issue, request for it to be assigned to you, or just create a pull request after following the steps below. Mention this issue in the description of the pull request.
  3. Fix the issue locally.
  4. Run the test suite locally. Remember that the subdirectories under test/ create fine-grained testing targets, so you can e.g. use make check-clang-ast to only run Clang's AST tests.
  5. Create a Git commit.
  6. Run git clang-format HEAD~1 to format your changes.
  7. Open a pull request to the upstream repository on GitHub. Detailed instructions can be found in GitHub's documentation. Mention this issue in the description of the pull request.

If you have any further questions about this issue, don't hesitate to ask via a comment in the thread below.

@llvmbot
Copy link
Member

llvmbot commented Mar 31, 2025

@llvm/issue-subscribers-good-first-issue

Author: Janeczko Jakub (qbojj)

https://clang.llvm.org/docs/AttributeReference.html#randomize-layout-no-randomize-layout and the following entry are (almost) the same.

The only difference is that the first table is for no_randomize_layout and the next is for randomize_layout.

@AaronBallman
Copy link
Collaborator

The same issue exists for xray_always_instrument, xray_never_instrument, xray_log_args and https://clang.llvm.org/docs/AttributeReference.html#cf-consumed/https://clang.llvm.org/docs/AttributeReference.html#cf-returns-not-retained, as well as others. If we're fixing one, we should fix them all at the same time.

The issue is that ClangAttrEmitter.cpp doesn't unify documentation across attributes, so the same doc string used for two attributes generates two attributes on the list with identical documentation instead of merging the attributes together into one entry.

@EugeneZelenko EugeneZelenko added the clang Clang issues not falling into any other category label Mar 31, 2025
@YLChenZ
Copy link
Contributor

YLChenZ commented Mar 31, 2025

Hi @dtcxzyw. I'd like to work on this issue. Can you assign it to me?

@YLChenZ
Copy link
Contributor

YLChenZ commented Apr 3, 2025

Hi @AaronBallman, I've submitted a PR for this issue and would be grateful if you could kindly review it when you have a moment. Thank you so much for your time and guidance!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
clang Clang issues not falling into any other category documentation good first issue https://github.com/llvm/llvm-project/contribute
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants