aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Lattner <sabre@nondot.org>2008-01-15 04:34:22 +0000
committerChris Lattner <sabre@nondot.org>2008-01-15 04:34:22 +0000
commit0747baaf6accc331d74764f965b9386e44374eeb (patch)
treed30b0a86f20e5fb0bda7ec5ae8437a6da862d01c
parent6bfa8a121d69f16ca2cb48360a182f52e5930f0e (diff)
clarify that byval is valid for any pointer argument.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@45998 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r--docs/LangRef.html11
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/LangRef.html b/docs/LangRef.html
index fa5019370a..49bcc974f0 100644
--- a/docs/LangRef.html
+++ b/docs/LangRef.html
@@ -810,11 +810,12 @@ declare i32 @atoi(i8*) nounwind readonly
target-specific</dd>
<dt><tt>byval</tt></dt>
- <dd>This indicates that the pointer parameter is really an aggregate that
- was passed by value to the function. The attribute implies that a hidden
- copy of the struct is made between the caller and the callee, so the
- callee is unable to modify the struct in the callee. This attribute is only
- valid on llvm pointer arguments.</dd>
+ <dd>This indicates that the pointer parameter should really be passed by
+ value to the function. The attribute implies that a hidden copy of the
+ pointee is made between the caller and the callee, so the callee is unable
+ to modify the value in the callee. This attribute is only valid on llvm
+ pointer arguments. It is generally used to pass structs and arrays by
+ value, but is also valid on scalars (even though this is silly).</dd>
<dt><tt>sret</tt></dt>
<dd>This indicates that the parameter specifies the address of a structure