Document the stack alignment part of target data description.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@73089 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Daniel Dunbar 2009-06-08 22:17:53 +00:00
parent fbbf1eeccf
commit 87bde0b7d3

View File

@ -1177,6 +1177,9 @@ aspect of the data layout. The specifications accepted are as follows: </p>
<dt><tt>a<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt> <dt><tt>a<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
<dd>This specifies the alignment for an aggregate type of a given bit <dd>This specifies the alignment for an aggregate type of a given bit
<i>size</i>.</dd> <i>size</i>.</dd>
<dt><tt>s<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
<dd>This specifies the alignment for a stack object of a given bit
<i>size</i>.</dd>
</dl> </dl>
<p>When constructing the data layout for a given target, LLVM starts with a <p>When constructing the data layout for a given target, LLVM starts with a
default set of specifications which are then (possibly) overriden by the default set of specifications which are then (possibly) overriden by the
@ -1196,6 +1199,7 @@ are given in this list:</p>
<li><tt>v64:64:64</tt> - 64-bit vector is 64-bit aligned</li> <li><tt>v64:64:64</tt> - 64-bit vector is 64-bit aligned</li>
<li><tt>v128:128:128</tt> - 128-bit vector is 128-bit aligned</li> <li><tt>v128:128:128</tt> - 128-bit vector is 128-bit aligned</li>
<li><tt>a0:0:1</tt> - aggregates are 8-bit aligned</li> <li><tt>a0:0:1</tt> - aggregates are 8-bit aligned</li>
<li><tt>s0:64:64</tt> - stack objects are 64-bit aligned</li>
</ul> </ul>
<p>When LLVM is determining the alignment for a given type, it uses the <p>When LLVM is determining the alignment for a given type, it uses the
following rules:</p> following rules:</p>