Skip to content

Commit 769a387

Browse files
committed
Describe where pref is used, rewrap to 80
1 parent 25d3736 commit 769a387

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

llvm/docs/LangRef.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3240,23 +3240,24 @@ as follows:
32403240
as :ref:`Non-Integral Pointer Type <nointptrtype>` s. The ``0``
32413241
address space cannot be specified as non-integral.
32423242

3243-
``<abi>`` is a lower bound on what is required for a type to be
3244-
considered aligned. This is used in various places, such as:
3243+
``<abi>`` is a lower bound on what is required for a type to be considered
3244+
aligned. This is used in various places, such as:
32453245

32463246
- The alignment for loads and stores if none is explicitly given.
32473247
- The alignment used to compute struct layout.
3248-
- The alignment used to compute allocation sizes and thus
3249-
``getelementptr`` offsets.
3248+
- The alignment used to compute allocation sizes and thus ``getelementptr``
3249+
offsets.
32503250
- The alignment below which accesses are considered underaligned.
32513251

3252-
``<pref>`` allows providing a more optimal alignment that should be used
3253-
when possible. ``<pref>`` is an optional value that must be greater than
3254-
or equal to ``<abi>``. If omitted, the preceding ``:`` should also be
3255-
omitted and ``<pref>`` will be equal to ``<abi>``.
3252+
``<pref>`` allows providing a more optimal alignment that should be used when
3253+
possible, primarily for ``alloca`` and the alignment of global variables. It is
3254+
an optional value that must be greater than or equal to ``<abi>``. If omitted,
3255+
the preceding ``:`` should also be omitted and ``<pref>`` will be equal to
3256+
``<abi>``.
32563257

3257-
Unless explicitly stated otherwise, every alignment specification is
3258-
provided in bits and must be in the range [1,2^16). The value must be a
3259-
power of times the width of a byte (i.e. ``align = 8 * 2^N``).
3258+
Unless explicitly stated otherwise, every alignment specification is provided in
3259+
bits and must be in the range [1,2^16). The value must be a power of two times
3260+
the width of a byte (i.e. ``align = 8 * 2^N``).
32603261

32613262
When constructing the data layout for a given target, LLVM starts with a
32623263
default set of specifications which are then (possibly) overridden by

0 commit comments

Comments
 (0)