Skip to content

Commit 7f87542

Browse files
committed
Fix bullet list formatting
1 parent 6489ef2 commit 7f87542

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

llvm/docs/HowToUpdateDebugInfo.rst

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -179,21 +179,24 @@ instruction, that location should be annotated accordingly. There are a set of
179179
special ``DebugLoc`` values that can be used to indicate the reason that a new
180180
instruction does not have a valid location. These are as follows:
181181

182-
- ``DebugLoc::getCompilerGenerated()``: This indicates that the instruction is a
183-
compiler-generated instruction, i.e. it is not associated with any user source
184-
code.
185-
- ``DebugLoc::getDropped()``: This indicates that the instruction has
186-
intentionally had its source location removed, according to the rules for
187-
dropping locations; this is set automatically by
188-
``Instruction::dropLocation()``.
189-
- ``DebugLoc::getUnknown()``: This indicates that the instruction does not have
190-
a known or currently knowable source location, e.g. the attribution is ambiguous
191-
in a way that can't currently be represented in LLVM, or that it is otherwise
192-
infeasible to determine or track the correct source location.
193-
- ``DebugLoc::getTemporary()``: This is used for instructions that we don't
194-
expect to be emitted (e.g. ``UnreachableInst``), and so should not need a valid
195-
location; if we ever try to emit a temporary location into an object file, this
196-
indicates that something has gone wrong.
182+
* ``DebugLoc::getCompilerGenerated()``: This indicates that the instruction is a
183+
compiler-generated instruction, i.e. it is not associated with any user source
184+
code.
185+
186+
* ``DebugLoc::getDropped()``: This indicates that the instruction has
187+
intentionally had its source location removed, according to the rules for
188+
dropping locations; this is set automatically by
189+
``Instruction::dropLocation()``.
190+
191+
* ``DebugLoc::getUnknown()``: This indicates that the instruction does not have
192+
a known or currently knowable source location, e.g. the attribution is ambiguous
193+
in a way that can't currently be represented in LLVM, or that it is otherwise
194+
infeasible to determine or track the correct source location.
195+
196+
* ``DebugLoc::getTemporary()``: This is used for instructions that we don't
197+
expect to be emitted (e.g. ``UnreachableInst``), and so should not need a valid
198+
location; if we ever try to emit a temporary location into an object file, this
199+
indicates that something has gone wrong.
197200

198201
Where applicable, these should be used instead of leaving an instruction without
199202
an assigned location or explicitly setting the location as ``DebugLoc()``.

0 commit comments

Comments
 (0)