maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

Fixed some typos and broken links in source level debugging docs. 

llvm-svn: 237357
This commit is contained in:
Michael Kuperstein 2015-05-14 10:58:59 +00:00
parent ec1de82213
commit 605308a421
2 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
llvm/docs/LangRef.rst
View File

@ -2961,7 +2961,7 @@ DIFile
Files are sometimes used in ``scope:`` fields, and are the only valid target Files are sometimes used in ``scope:`` fields, and are the only valid target
for ``file:`` fields. for ``file:`` fields.
.. _DILocation: .. _DIBasicType:
DIBasicType DIBasicType
""""""""""" """""""""""
@ -3225,6 +3225,8 @@ discriminate between control flow within a single block in the source language.
!1 = !DILexicalBlockFile(scope: !0, file: !4, discriminator: 0) !1 = !DILexicalBlockFile(scope: !0, file: !4, discriminator: 0)
!2 = !DILexicalBlockFile(scope: !0, file: !4, discriminator: 1) !2 = !DILexicalBlockFile(scope: !0, file: !4, discriminator: 1)
.. _DILocation:
DILocation DILocation
"""""""""" """"""""""

20
llvm/docs/SourceLevelDebugging.rst
View File

@ -153,8 +153,8 @@ debugger to interpret the information.
To provide basic functionality, the LLVM debugger does have to make some To provide basic functionality, the LLVM debugger does have to make some
assumptions about the source-level language being debugged, though it keeps assumptions about the source-level language being debugged, though it keeps
these to a minimum. The only common features that the LLVM debugger assumes these to a minimum. The only common features that the LLVM debugger assumes
exist are `source files <LangRef.html#DIFile>`_, and `program objects exist are `source files <LangRef.html#difile>`_, and `program objects
<LangRef.html#DIGlobalVariable>`_. These abstract objects are used by a <LangRef.html#diglobalvariable>`_. These abstract objects are used by a
debugger to form stack traces, show information about local variables, etc. debugger to form stack traces, show information about local variables, etc.
This section of the documentation first describes the representation aspects This section of the documentation first describes the representation aspects
@ -177,27 +177,27 @@ provide debug information at various points in generated code.
.. code-block:: llvm .. code-block:: llvm
void %llvm.dbg.declare(metadata, metadata, metadata) void @llvm.dbg.declare(metadata, metadata, metadata)
This intrinsic provides information about a local element (e.g., variable). This intrinsic provides information about a local element (e.g., variable).
The first argument is metadata holding the alloca for the variable. The second The first argument is metadata holding the alloca for the variable. The second
argument is a `local variable <LangRef.html#DILocalVariable>`_ containing a argument is a `local variable <LangRef.html#dilocalvariable>`_ containing a
description of the variable. The third argument is a `complex expression description of the variable. The third argument is a `complex expression
<LangRef.html#DIExpression>`_. <LangRef.html#diexpression>`_.
``llvm.dbg.value`` ``llvm.dbg.value``
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
.. code-block:: llvm .. code-block:: llvm
void %llvm.dbg.value(metadata, i64, metadata, metadata) void @llvm.dbg.value(metadata, i64, metadata, metadata)
This intrinsic provides information when a user source variable is set to a new This intrinsic provides information when a user source variable is set to a new
value. The first argument is the new value (wrapped as metadata). The second value. The first argument is the new value (wrapped as metadata). The second
argument is the offset in the user source variable where the new value is argument is the offset in the user source variable where the new value is
written. The third argument is a `local variable written. The third argument is a `local variable
<LangRef.html#DILocalVariable>`_ containing a description of the variable. The <LangRef.html#dilocalvariable>`_ containing a description of the variable. The
third argument is a `complex expression <LangRef.html#DIExpression>`_. third argument is a `complex expression <LangRef.html#diexpression>`_.
Object lifetimes and scoping Object lifetimes and scoping
============================ ============================
@ -310,8 +310,8 @@ scope information for the variable ``X``.
variables: !2) variables: !2)
Here ``!14`` is metadata providing `location information Here ``!14`` is metadata providing `location information
<LangRef.html#DILocation>`_. In this example, scope is encoded by ``!4``, a <LangRef.html#dilocation>`_. In this example, scope is encoded by ``!4``, a
`subprogram descriptor <LangRef.html#DISubprogram>`_. This way the location `subprogram descriptor <LangRef.html#disubprogram>`_. This way the location
information attached to the intrinsics indicates that the variable ``X`` is information attached to the intrinsics indicates that the variable ``X`` is
declared at line number 2 at a function level scope in function ``foo``. declared at line number 2 at a function level scope in function ``foo``.