Skip to content

Commit 4393d16

Browse files
[llvm] Proofread LangRef.rst (#153358)
This patch quotes code-related terms like ``llvm.memset``.
1 parent 3fe9332 commit 4393d16

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

llvm/docs/LangRef.rst

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ added in the future:
392392
sequence in place of a call site. This convention forces the call
393393
arguments into registers but allows them to be dynamically
394394
allocated. This can currently only be used with calls to
395-
llvm.experimental.patchpoint because only this intrinsic records
395+
``llvm.experimental.patchpoint`` because only this intrinsic records
396396
the location of its arguments in a side table. See :doc:`StackMaps`.
397397
"``preserve_mostcc``" - The `PreserveMost` calling convention
398398
This calling convention attempts to make the code in the caller as
@@ -610,7 +610,7 @@ model is not supported, or if a better choice of model can be made.
610610
A model can also be specified in an alias, but then it only governs how
611611
the alias is accessed. It will not have any effect on the aliasee.
612612

613-
For platforms without linker support of ELF TLS model, the -femulated-tls
613+
For platforms without linker support of ELF TLS model, the ``-femulated-tls``
614614
flag can be used to generate GCC-compatible emulated TLS code.
615615

616616
.. _runtime_preemption_model:
@@ -3641,8 +3641,8 @@ to support the somewhat common pattern in C of intentionally storing to an
36413641
invalid pointer to crash the program. In the future, it might make sense to
36423642
allow frontends to control this behavior.
36433643

3644-
IR-level volatile loads and stores cannot safely be optimized into llvm.memcpy
3645-
or llvm.memmove intrinsics even when those intrinsics are flagged volatile.
3644+
IR-level volatile loads and stores cannot safely be optimized into ``llvm.memcpy``
3645+
or ``llvm.memmove`` intrinsics even when those intrinsics are flagged volatile.
36463646
Likewise, the backend should never split or merge target-legal volatile
36473647
load/store instructions. Similarly, IR-level volatile loads and stores cannot
36483648
change from integer to floating-point or vice versa.
@@ -6448,18 +6448,18 @@ descriptors <DISubrange>` or :ref:`subrange descriptors
64486448
<DISubrangeType>`, each representing the range of subscripts at that
64496449
level of indexing. The ``DIFlagVector`` flag to ``flags:`` indicates
64506450
that an array type is a native packed vector. The optional
6451-
``dataLocation`` is a DIExpression that describes how to get from an
6451+
``dataLocation`` is a ``DIExpression`` that describes how to get from an
64526452
object's address to the actual raw data, if they aren't
64536453
equivalent. This is only supported for array types, particularly to
64546454
describe Fortran arrays, which have an array descriptor in addition to
6455-
the array data. Alternatively it can also be DIVariable which has the
6455+
the array data. Alternatively it can also be ``DIVariable`` which has the
64566456
address of the actual raw data. The Fortran language supports pointer
64576457
arrays which can be attached to actual arrays, this attachment between
64586458
pointer and pointee is called association. The optional
6459-
``associated`` is a DIExpression that describes whether the pointer
6459+
``associated`` is a ``DIExpression`` that describes whether the pointer
64606460
array is currently associated. The optional ``allocated`` is a
6461-
DIExpression that describes whether the allocatable array is currently
6462-
allocated. The optional ``rank`` is a DIExpression that describes the
6461+
``DIExpression`` that describes whether the allocatable array is currently
6462+
allocated. The optional ``rank`` is a ``DIExpression`` that describes the
64636463
rank (number of dimensions) of fortran assumed rank array (rank is
64646464
known at runtime). The optional ``bitStride`` is an unsigned constant
64656465
that describes the number of bits occupied by an element of the array;
@@ -6763,7 +6763,7 @@ expression language. They are used in :ref:`debug records <debugrecords>`
67636763
referenced LLVM variable relates to the source language variable. Debug
67646764
expressions are interpreted left-to-right: start by pushing the value/address
67656765
operand of the record onto a stack, then repeatedly push and evaluate
6766-
opcodes from the DIExpression until the final variable description is produced.
6766+
opcodes from the ``DIExpression`` until the final variable description is produced.
67676767

67686768
The current supported opcode vocabulary is limited:
67696769

@@ -6852,7 +6852,7 @@ The current supported opcode vocabulary is limited:
68526852
- ``DW_OP_LLVM_implicit_pointer`` It specifies the dereferenced value. It can
68536853
be used to represent pointer variables which are optimized out but the value
68546854
it points to is known. This operator is required as it is different than DWARF
6855-
operator DW_OP_implicit_pointer in representation and specification (number
6855+
operator ``DW_OP_implicit_pointer`` in representation and specification (number
68566856
and types of operands) and later can not be used as multiple level.
68576857

68586858
.. code-block:: text
@@ -6889,22 +6889,22 @@ in registers or in memory (see ``DW_OP_stack_value``).
68896889

68906890
A ``#dbg_declare`` record describes an indirect value (the address) of a
68916891
source variable. The first operand of the record must be an address of some
6892-
kind. A DIExpression operand to the record refines this address to produce a
6892+
kind. A ``DIExpression`` operand to the record refines this address to produce a
68936893
concrete location for the source variable.
68946894

68956895
A ``#dbg_value`` record describes the direct value of a source variable.
68966896
The first operand of the record may be a direct or indirect value. A
6897-
DIExpression operand to the record refines the first operand to produce a
6897+
``DIExpression`` operand to the record refines the first operand to produce a
68986898
direct value. For example, if the first operand is an indirect value, it may be
6899-
necessary to insert ``DW_OP_deref`` into the DIExpression in order to produce a
6899+
necessary to insert ``DW_OP_deref`` into the ``DIExpression`` in order to produce a
69006900
valid debug record.
69016901

69026902
.. note::
69036903

6904-
A DIExpression is interpreted in the same way regardless of which kind of
6904+
A ``DIExpression`` is interpreted in the same way regardless of which kind of
69056905
debug record it's attached to.
69066906

6907-
DIExpressions are always printed and parsed inline; they can never be
6907+
``DIExpressions`` are always printed and parsed inline; they can never be
69086908
referenced by an ID (e.g. ``!1``).
69096909

69106910
.. code-block:: text
@@ -6944,7 +6944,7 @@ DIArgList
69446944
``DIArgList`` nodes hold a list of constant or SSA value references. These are
69456945
used in :ref:`debug records <debugrecords>` in combination with a
69466946
``DIExpression`` that uses the
6947-
``DW_OP_LLVM_arg`` operator. Because a DIArgList may refer to local values
6947+
``DW_OP_LLVM_arg`` operator. Because a ``DIArgList`` may refer to local values
69486948
within a function, it must only be used as a function argument, must always be
69496949
inlined, and cannot appear in named metadata.
69506950

@@ -6962,7 +6962,7 @@ These flags encode various properties of DINodes.
69626962

69636963
The `ExportSymbols` flag marks a class, struct or union whose members
69646964
may be referenced as if they were defined in the containing class or
6965-
union. This flag is used to decide whether the DW_AT_export_symbols can
6965+
union. This flag is used to decide whether the ``DW_AT_export_symbols`` can
69666966
be used for the structure type.
69676967

69686968
DIObjCProperty
@@ -7539,7 +7539,7 @@ sections that the user does not want removed after linking.
75397539

75407540
``unpredictable`` metadata may be attached to any branch or switch
75417541
instruction. It can be used to express the unpredictability of control
7542-
flow. Similar to the llvm.expect intrinsic, it may be used to alter
7542+
flow. Similar to the ``llvm.expect`` intrinsic, it may be used to alter
75437543
optimizations related to compare and branch instructions. The metadata
75447544
is treated as a boolean value; if it exists, it signals that the branch
75457545
or switch that it is attached to is completely unpredictable.
@@ -7977,7 +7977,7 @@ performed on this loop. The metadata has a single operand which is the string
79777977

79787978
!0 = !{!"llvm.licm.disable"}
79797979

7980-
Note that although it operates per loop it isn't given the llvm.loop prefix
7980+
Note that although it operates per loop it isn't given the ``llvm.loop`` prefix
79817981
as it is not affected by the ``llvm.loop.disable_nonforced`` metadata.
79827982

79837983
'``llvm.access.group``' Metadata
@@ -8174,8 +8174,8 @@ Examples:
81748174

81758175
!0 = !{}
81768176

8177-
The invariant.group metadata must be dropped when replacing one pointer by
8178-
another based on aliasing information. This is because invariant.group is tied
8177+
The ``invariant.group`` metadata must be dropped when replacing one pointer by
8178+
another based on aliasing information. This is because ``invariant.group`` is tied
81798179
to the SSA value of the pointer operand.
81808180

81818181
.. code-block:: llvm
@@ -8275,9 +8275,9 @@ value profile information. Currently this is indirect calls (where it
82758275
records the hottest callees) and calls to memory intrinsics such as memcpy,
82768276
memmove, and memset (where it records the hottest byte lengths).
82778277

8278-
Each VP metadata node contains "VP" string, then a uint32_t value for the value
8279-
profiling kind, a uint64_t value for the total number of times the instruction
8280-
is executed, followed by uint64_t value and execution count pairs.
8278+
Each VP metadata node contains "VP" string, then a ``uint32_t`` value for the value
8279+
profiling kind, a ``uint64_t`` value for the total number of times the instruction
8280+
is executed, followed by ``uint64_t`` value and execution count pairs.
82818281
The value profiling kind is 0 for indirect call targets and 1 for memory
82828282
operations. For indirect call targets, each profile value is a hash
82838283
of the callee function name, and for memory operations each value is the
@@ -15744,7 +15744,7 @@ external functions.
1574415744
Syntax:
1574515745
"""""""
1574615746

15747-
This is an overloaded intrinsic. You can use llvm.memmove on any integer
15747+
This is an overloaded intrinsic. You can use ``llvm.memmove`` on any integer
1574815748
bit width and for different address space. Not all targets support all
1574915749
bit widths however.
1575015750

@@ -15805,7 +15805,7 @@ otherwise the behavior is undefined.
1580515805
Syntax:
1580615806
"""""""
1580715807

15808-
This is an overloaded intrinsic. You can use llvm.memset on any integer
15808+
This is an overloaded intrinsic. You can use ``llvm.memset`` on any integer
1580915809
bit width and for different address spaces. However, not all targets
1581015810
support all bit widths.
1581115811

@@ -17994,7 +17994,7 @@ operate on a per-element basis and the element order is not affected.
1799417994
Syntax:
1799517995
"""""""
1799617996

17997-
This is an overloaded intrinsic. You can use llvm.ctpop on any integer
17997+
This is an overloaded intrinsic. You can use ``llvm.ctpop`` on any integer
1799817998
bit width, or on any vector with integer elements. Not all targets
1799917999
support all bit widths or vector types, however.
1800018000

@@ -26414,7 +26414,7 @@ This is an overloaded intrinsic.
2641426414
Overview:
2641526415
"""""""""
2641626416

26417-
Predicated llvm.is.fpclass :ref:`llvm.is.fpclass <llvm.is.fpclass>`
26417+
Predicated ``llvm.is.fpclass`` :ref:`llvm.is.fpclass <llvm.is.fpclass>`
2641826418

2641926419
Arguments:
2642026420
""""""""""
@@ -26429,7 +26429,7 @@ operation.
2642926429
Semantics:
2643026430
""""""""""
2643126431

26432-
The '``llvm.vp.is.fpclass``' intrinsic performs llvm.is.fpclass (:ref:`llvm.is.fpclass <llvm.is.fpclass>`).
26432+
The '``llvm.vp.is.fpclass``' intrinsic performs ``llvm.is.fpclass`` (:ref:`llvm.is.fpclass <llvm.is.fpclass>`).
2643326433

2643426434

2643526435
Examples:
@@ -28493,7 +28493,7 @@ environment. The rounding mode argument is only intended as information
2849328493
to the compiler.
2849428494

2849528495
If the runtime floating-point environment is using the default rounding mode
28496-
then the results will be the same as the llvm.lrint intrinsic.
28496+
then the results will be the same as the ``llvm.lrint`` intrinsic.
2849728497

2849828498

2849928499
'``llvm.experimental.constrained.llrint``' Intrinsic
@@ -28541,7 +28541,7 @@ environment. The rounding mode argument is only intended as information
2854128541
to the compiler.
2854228542

2854328543
If the runtime floating-point environment is using the default rounding mode
28544-
then the results will be the same as the llvm.llrint intrinsic.
28544+
then the results will be the same as the ``llvm.llrint intrinsic``.
2854528545

2854628546

2854728547
'``llvm.experimental.constrained.nearbyint``' Intrinsic
@@ -30457,7 +30457,7 @@ has externally observable side effects.
3045730457
Syntax:
3045830458
"""""""
3045930459

30460-
This is an overloaded intrinsic. You can use llvm.is.constant with any argument type.
30460+
This is an overloaded intrinsic. You can use ``llvm.is.constant`` with any argument type.
3046130461

3046230462
::
3046330463

0 commit comments

Comments
 (0)