[LangRef] Replace 'the argument' with 'the first argument' in llvm.abs description. NFC #97386
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
…s description. NFC Make it more clear which argument we're referring to. Similar for vp.abs.
|
@llvm/pr-subscribers-llvm-ir Author: Craig Topper (topperc) ChangesMake it more clear which argument we're referring to. Similar for vp.abs. Full diff: https://github.com/llvm/llvm-project/pull/97386.diff 1 Files Affected:
diff --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst
index e2c47204e628f..426f56d22dd79 100644
--- a/llvm/docs/LangRef.rst
+++ b/llvm/docs/LangRef.rst
@@ -14740,16 +14740,16 @@ The return type must match the first argument type.
The second argument must be a constant and is a flag to indicate whether the
result value of the '``llvm.abs``' intrinsic is a
-:ref:`poison value <poisonvalues>` if the argument is statically or dynamically
-an ``INT_MIN`` value.
+:ref:`poison value <poisonvalues>` if the first argument is statically or
+dynamically an ``INT_MIN`` value.
Semantics:
""""""""""
The '``llvm.abs``' intrinsic returns the magnitude (always positive) of the
-argument or each element of a vector argument.". If the argument is ``INT_MIN``,
-then the result is also ``INT_MIN`` if ``is_int_min_poison == 0`` and
-``poison`` otherwise.
+first argument or each element of a vector argument.". If the first argument is
+``INT_MIN``, then the result is also ``INT_MIN`` if ``is_int_min_poison == 0``
+and ``poison`` otherwise.
.. _int_smax:
@@ -20812,10 +20812,10 @@ Arguments:
The first operand and the result have the same vector of integer type. The
second operand is the vector mask and has the same number of elements as the
result vector type. The third operand is the explicit vector length of the
-operation. The fourth argument must be a constant and is a flag to indicate
+operation. The fourth operand must be a constant and is a flag to indicate
whether the result value of the '``llvm.vp.abs``' intrinsic is a
-:ref:`poison value <poisonvalues>` if the argument is statically or dynamically
-an ``INT_MIN`` value.
+:ref:`poison value <poisonvalues>` if the first argument is statically or
+dynamically an ``INT_MIN`` value.
Semantics:
""""""""""
|
nikic
approved these changes
Jul 2, 2024
| :ref:`poison value <poisonvalues>` if the argument is statically or dynamically | ||
| an ``INT_MIN`` value. | ||
| :ref:`poison value <poisonvalues>` if the first argument is statically or | ||
| dynamically an ``INT_MIN`` value. |
There was a problem hiding this comment.
This description has a weird mix of operand and argument -- should probably be argument everywhere?
There was a problem hiding this comment.
LOL - I just recommended that we consistently use argument on another patch as that's what the subsection is called - don't really care which we chose, just want it to be consistent.
There was a problem hiding this comment.
I was trying to make it consistent with preceding text and still failed.
topperc
added a commit
to topperc/llvm-project
that referenced
this pull request
Jul 2, 2024
…s. NFC Fixes inconsistencies noted in llvm#97386 and llvm#97387. There are still more intrinsics that have the same issue. I might submit more patches for those.
lravenclaw
pushed a commit
to lravenclaw/llvm-project
that referenced
this pull request
Jul 3, 2024
…s description. NFC (llvm#97386) Make it more clear which argument we're referring to. Similar for vp.abs.
lravenclaw
pushed a commit
to lravenclaw/llvm-project
that referenced
this pull request
Jul 3, 2024
…sics. NFC (llvm#97437) Fixes inconsistencies noted in llvm#97386 and llvm#97387. There are still more intrinsics that have the same issue. I might submit more patches for those.
kbluck
pushed a commit
to kbluck/llvm-project
that referenced
this pull request
Jul 6, 2024
…s description. NFC (llvm#97386) Make it more clear which argument we're referring to. Similar for vp.abs.
kbluck
pushed a commit
to kbluck/llvm-project
that referenced
this pull request
Jul 6, 2024
…sics. NFC (llvm#97437) Fixes inconsistencies noted in llvm#97386 and llvm#97387. There are still more intrinsics that have the same issue. I might submit more patches for those.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Make it more clear which argument we're referring to.
Similar for vp.abs.