Skip to content

[llvm][docs] Small improvements to llvm-test-suite doc #139083

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 2 commits into from
May 9, 2025

Conversation

DavidSpickett
Copy link
Collaborator

@DavidSpickett DavidSpickett commented May 8, 2025

  • Mention earlier that the C++ compiler will be inferred from the C compiler setting. It does say this later, but a mention earlier will save people (aka me) from wondering why we don't set CMAKE_CXX_COMPILER.
  • Mention earlier the compile only TEST_SUITE_RUN_BENCHMARKS=OFF setting, as it's a common use case. We already say the consequences of doing that, but not actually how to enable it until later in the doc.
  • Reorder that text to make more sense.
  • Make it into a proper Sphinx note block.

* Mention earlier that the C++ compiler will be inferred from the C
  compiler setting. It does say this later, but a mention earlier
  will save people (aka me) from wondering why we don't set
  CMAKE_CXX_COMPILER.
* Mention earlier the compile only TEST_SUITE_RUN_BENCHMARKS=OFF
  setting, as it's a common use case. We already say the consequences
  of doing that, but not actually how to enable it until later in the doc.
Copy link
Contributor

@tarunprabhu tarunprabhu left a comment

Choose a reason for hiding this comment

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

Thanks, David. Just one small suggestion.

@DavidSpickett DavidSpickett changed the title [llvm][docs] Two small improvements to llvm-test-suite doc [llvm][docs] Small improvements to llvm-test-suite doc May 8, 2025
Copy link
Contributor

@tarunprabhu tarunprabhu left a comment

Choose a reason for hiding this comment

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

Thanks for the change, David. LGTM.

@DavidSpickett DavidSpickett merged commit 7948b39 into llvm:main May 9, 2025
10 checks passed
@DavidSpickett DavidSpickett deleted the testsuite-docs branch May 9, 2025 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants