[llvm] b0a1a30 - LangRef: fix bad indentation in allockind bullets
Augie Fackler via llvm-commits
llvm-commits at lists.llvm.org
Tue May 31 08:06:50 PDT 2022
Author: Augie Fackler
Date: 2022-05-31T11:06:43-04:00
New Revision: b0a1a308f268249565823b7992249393f2a52887
URL: https://github.com/llvm/llvm-project/commit/b0a1a308f268249565823b7992249393f2a52887
DIFF: https://github.com/llvm/llvm-project/commit/b0a1a308f268249565823b7992249393f2a52887.diff
LOG: LangRef: fix bad indentation in allockind bullets
Added:
Modified:
llvm/docs/LangRef.rst
Removed:
################################################################################
diff --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst
index f7ebf8aadd47..d5540229a4b2 100644
--- a/llvm/docs/LangRef.rst
+++ b/llvm/docs/LangRef.rst
@@ -1587,21 +1587,23 @@ example:
``allockind("KIND")``
Describes the behavior of an allocation function. The KIND string contains comma
separated entries from the following options:
- * "alloc": the function returns a new block of memory or null.
- * "realloc": the function returns a new block of memory or null. If the
- result is non-null the memory contents from the start of the block up to
- the smaller of the original allocation size and the new allocation size
- will match that of the ``allocptr`` argument and the ``allocptr``
- argument is invalidated, even if the function returns the same address.
- * "free": the function frees the block of memory specified by ``allocptr``.
- * "uninitialized": Any newly-allocated memory (either a new block from
- a "alloc" function or the enlarged capacity from a "realloc" function)
- will be uninitialized.
- * "zeroed": Any newly-allocated memory (either a new block from a "alloc"
- function or the enlarged capacity from a "realloc" function) will be
- zeroed.
- * "aligned": the function returns memory aligned according to the
- ``allocalign`` parameter.
+
+ * "alloc": the function returns a new block of memory or null.
+ * "realloc": the function returns a new block of memory or null. If the
+ result is non-null the memory contents from the start of the block up to
+ the smaller of the original allocation size and the new allocation size
+ will match that of the ``allocptr`` argument and the ``allocptr``
+ argument is invalidated, even if the function returns the same address.
+ * "free": the function frees the block of memory specified by ``allocptr``.
+ * "uninitialized": Any newly-allocated memory (either a new block from
+ a "alloc" function or the enlarged capacity from a "realloc" function)
+ will be uninitialized.
+ * "zeroed": Any newly-allocated memory (either a new block from a "alloc"
+ function or the enlarged capacity from a "realloc" function) will be
+ zeroed.
+ * "aligned": the function returns memory aligned according to the
+ ``allocalign`` parameter.
+
The first three options are mutually exclusive, and the remaining options
describe more details of how the function behaves. The remaining options
are invalid for "free"-type functions.
More information about the llvm-commits
mailing list