[clang][docs][RISCV] Pre-pend the HelpText for -mrvv-vector-bits into the DocBrief. #144128
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… the DocBrief. The DocBrief is used to generate the webpage description of the optio. The current text only talks about the possible values, but not what the option does.
llvmbot
added
clang
Member
|
@llvm/pr-subscribers-clang Author: Craig Topper (topperc) ChangesThe DocBrief is used to generate the webpage description of the option. The current text only talks about the possible values, but not what the option does. Full diff: https://github.com/llvm/llvm-project/pull/144128.diff 1 Files Affected:
diff --git a/clang/include/clang/Driver/Options.td b/clang/include/clang/Driver/Options.td
index 152df89118a6a..5097630098911 100644
--- a/clang/include/clang/Driver/Options.td
+++ b/clang/include/clang/Driver/Options.td
@@ -5056,9 +5056,10 @@ def mrvv_vector_bits_EQ : Joined<["-"], "mrvv-vector-bits=">, Group<m_Group>,
Visibility<[ClangOption, FlangOption]>,
HelpText<"Specify the size in bits of an RVV vector register">,
DocBrief<!strconcat(
- "Defaults to the vector length agnostic value of \"scalable\". "
- "Accepts power of 2 values between 64 and 65536. Also accepts "
- "\"zvl\" to use the value implied by -march/-mcpu.",
+ "Specify the size in bits of an RVV vector register. Defaults to the "
+ "vector length agnostic value of \"scalable\". Accepts power of 2 values "
+ "between 64 and 65536. Also accepts \"zvl\" to use the value implied by "
+ "-march/-mcpu.",
!cond(
// Flang does not set the preprocessor define.
!eq(GlobalDocumentation.Program, "Flang") : "",
|
Member
|
@llvm/pr-subscribers-backend-risc-v Author: Craig Topper (topperc) ChangesThe DocBrief is used to generate the webpage description of the option. The current text only talks about the possible values, but not what the option does. Full diff: https://github.com/llvm/llvm-project/pull/144128.diff 1 Files Affected:
diff --git a/clang/include/clang/Driver/Options.td b/clang/include/clang/Driver/Options.td
index 152df89118a6a..5097630098911 100644
--- a/clang/include/clang/Driver/Options.td
+++ b/clang/include/clang/Driver/Options.td
@@ -5056,9 +5056,10 @@ def mrvv_vector_bits_EQ : Joined<["-"], "mrvv-vector-bits=">, Group<m_Group>,
Visibility<[ClangOption, FlangOption]>,
HelpText<"Specify the size in bits of an RVV vector register">,
DocBrief<!strconcat(
- "Defaults to the vector length agnostic value of \"scalable\". "
- "Accepts power of 2 values between 64 and 65536. Also accepts "
- "\"zvl\" to use the value implied by -march/-mcpu.",
+ "Specify the size in bits of an RVV vector register. Defaults to the "
+ "vector length agnostic value of \"scalable\". Accepts power of 2 values "
+ "between 64 and 65536. Also accepts \"zvl\" to use the value implied by "
+ "-march/-mcpu.",
!cond(
// Flang does not set the preprocessor define.
!eq(GlobalDocumentation.Program, "Flang") : "",
|
lukel97
approved these changes
Jun 13, 2025
tomtor
pushed a commit
to tomtor/llvm-project
that referenced
this pull request
Jun 14, 2025
…the DocBrief. (llvm#144128) The DocBrief is used to generate the webpage description of the option. The current text only talks about the possible values, but not what the option does.
akuhlens
pushed a commit
to akuhlens/llvm-project
that referenced
this pull request
Jun 24, 2025
…the DocBrief. (llvm#144128) The DocBrief is used to generate the webpage description of the option. The current text only talks about the possible values, but not what the option does.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The DocBrief is used to generate the webpage description of the option. The current text only talks about the possible values, but not what the option does.