Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[X86] Properly test headers with Wdocumentation #35297

Closed
RKSimon opened this issue Jan 15, 2018 · 4 comments
Closed

[X86] Properly test headers with Wdocumentation #35297

RKSimon opened this issue Jan 15, 2018 · 4 comments
Assignees
@RKSimon
Labels
backend:X86 bugzilla Issues migrated from bugzilla clang:headers Headers provided by Clang, e.g. for intrinsics good first issue https://github.com/llvm/llvm-project/contribute

Comments

@RKSimon
Copy link
Collaborator

RKSimon commented Jan 15, 2018

Bugzilla Link 35949
Version unspecified
OS Windows NT
CC @topperc,@dyung,@rotateright

Extended Description

As mentioned on D41523, we should ensure that all the x86 builtin codegen tests are being properly tested with Wdocumentation to check for any anomalies in the doxygen within x86intrin.h etc.

Initial tests suggested that just adding -Wdocumentation to the RUN command doesn't seem to work so further investigation is necessary.
@llvmbot llvmbot transferred this issue from llvm/llvm-bugzilla-archive Dec 10, 2021
@llvmbot
Copy link
Member

llvmbot commented Apr 10, 2022

@llvm/issue-subscribers-backend-x86

@EugeneZelenko EugeneZelenko added good first issue https://github.com/llvm/llvm-project/contribute and removed beginner labels Apr 10, 2022
@llvmbot
Copy link
Member

llvmbot commented Apr 10, 2022

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

@RKSimon RKSimon mentioned this issue May 2, 2022
Closed
@RKSimon RKSimon self-assigned this May 7, 2022
RKSimon added a commit that referenced this issue May 7, 2022
@RKSimon
[Headers][X86] amxintrin.h - fixed unknown parameter Wdocumentation w…

Verified

This commit was signed with the committer’s verified signature. The key has expired.
eggyal
GPG key ID: 7D4C2F6C22122532
Expired
Verified
Learn about vigilant mode
e7806c0 
…arning. NFC

Noticed while triaging Issue #35297
RKSimon added a commit that referenced this issue May 8, 2022
@RKSimon
[Headers][X86] Replace \operation with \code{.operation}

Verified

This commit was signed with the committer’s verified signature. The key has expired.
eggyal
GPG key ID: 7D4C2F6C22122532
Expired
Verified
Learn about vigilant mode
6b3a111 
\operation ... \endoperation are not valid doxygen commands and cause issues when -Wdocumentation is enabled (Issue #35297)

This patch proposes to replace them with \code{.operation} ... \endcode blocks so that the pseudo-code is correctly retained in any documentation and downstream can use the ".operation" type for its own formatting.

Differential Revision: https://reviews.llvm.org/D125170
RKSimon added a commit that referenced this issue May 8, 2022
@RKSimon
[Headers][X86] Enable basic Wdocumentation testing on X86 headers
72eb630 
First part of Issue #35297 - we want to enable Wdocumentation-pedantic as well, but need '\n' support first which Issue #55319 is addressing
@RKSimon
Copy link
Collaborator Author

RKSimon commented May 8, 2022

Basic "-Wdocumentation" testing is now in, but we can't enable "-Wdocumentation-pedantic" yet which we realistically need to resolve this.

@RKSimon RKSimon mentioned this issue May 8, 2022
Closed
@RKSimon
Copy link
Collaborator Author

RKSimon commented May 13, 2022

Basic "-Wdocumentation" testing is now in, but we can't enable "-Wdocumentation-pedantic" yet which we realistically need to resolve this.

-Wdocumentation-pedantic and -Wdocumentation-unknown-command testing landed in d3a4033

@RKSimon RKSimon closed this as completed May 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@RKSimon RKSimon

Labels
backend:X86 bugzilla Issues migrated from bugzilla clang:headers Headers provided by Clang, e.g. for intrinsics good first issue https://github.com/llvm/llvm-project/contribute
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@RKSimon @EugeneZelenko @llvmbot