explain that NumElements in alloca and malloc defaults to one
[oota-llvm.git] / docs / LangRef.html
index 90ba0cc058f65c09046c83de0fb3f1bfbf527656..d9d5ca837359a447d76a5d2f857a83ee59eafc5e 100644 (file)
@@ -2760,10 +2760,10 @@ address space (address space zero).</p>
 <tt>sizeof(&lt;type&gt;)*NumElements</tt>
 bytes of memory from the operating system and returns a pointer of the
 appropriate type to the program.  If "NumElements" is specified, it is the
-number of elements allocated.  If an alignment is specified, the value result
-of the allocation is guaranteed to be aligned to at least that boundary.  If
-not specified, or if zero, the target can choose to align the allocation on any
-convenient boundary.</p>
+number of elements allocated, otherwise "NumElements" is defaulted to be one.
+If an alignment is specified, the value result of the allocation is guaranteed to
+be aligned to at least that boundary.  If not specified, or if zero, the target can
+choose to align the allocation on any convenient boundary.</p>
 
 <p>'<tt>type</tt>' must be a sized type.</p>
 
@@ -2846,11 +2846,11 @@ space (address space zero).</p>
 
 <p>The '<tt>alloca</tt>' instruction allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt>
 bytes of memory on the runtime stack, returning a pointer of the
-appropriate type to the program.    If "NumElements" is specified, it is the
-number of elements allocated.  If an alignment is specified, the value result
-of the allocation is guaranteed to be aligned to at least that boundary.  If
-not specified, or if zero, the target can choose to align the allocation on any
-convenient boundary.</p>
+appropriate type to the program.  If "NumElements" is specified, it is the
+number of elements allocated, otherwise "NumElements" is defaulted to be one.
+If an alignment is specified, the value result of the allocation is guaranteed
+to be aligned to at least that boundary.  If not specified, or if zero, the target
+can choose to align the allocation on any convenient boundary.</p>
 
 <p>'<tt>type</tt>' may be any sized type.</p>