From 6a882f890765b6e97f844e6e814d2c6e932d2eaa Mon Sep 17 00:00:00 2001 From: Michael Kuperstein Date: Thu, 14 May 2015 10:58:59 +0000 Subject: [PATCH] Fixed some typos and broken links in source level debugging docs. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@237357 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/LangRef.rst | 4 +++- docs/SourceLevelDebugging.rst | 20 ++++++++++---------- 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/LangRef.rst b/docs/LangRef.rst index 24765870dbf..48ac8fbc7db 100644 --- a/docs/LangRef.rst +++ b/docs/LangRef.rst @@ -2961,7 +2961,7 @@ DIFile Files are sometimes used in ``scope:`` fields, and are the only valid target for ``file:`` fields. -.. _DILocation: +.. _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) !2 = !DILexicalBlockFile(scope: !0, file: !4, discriminator: 1) +.. _DILocation: + DILocation """""""""" diff --git a/docs/SourceLevelDebugging.rst b/docs/SourceLevelDebugging.rst index 95f5d07d16a..99186f58188 100644 --- a/docs/SourceLevelDebugging.rst +++ b/docs/SourceLevelDebugging.rst @@ -153,8 +153,8 @@ debugger to interpret the information. To provide basic functionality, the LLVM debugger does have to make some assumptions about the source-level language being debugged, though it keeps these to a minimum. The only common features that the LLVM debugger assumes -exist are `source files `_, and `program objects -`_. These abstract objects are used by a +exist are `source files `_, and `program objects +`_. These abstract objects are used by a debugger to form stack traces, show information about local variables, etc. 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 - 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). The first argument is metadata holding the alloca for the variable. The second -argument is a `local variable `_ containing a +argument is a `local variable `_ containing a description of the variable. The third argument is a `complex expression -`_. +`_. ``llvm.dbg.value`` ^^^^^^^^^^^^^^^^^^ .. 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 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 written. The third argument is a `local variable -`_ containing a description of the variable. The -third argument is a `complex expression `_. +`_ containing a description of the variable. The +third argument is a `complex expression `_. Object lifetimes and scoping ============================ @@ -310,8 +310,8 @@ scope information for the variable ``X``. variables: !2) Here ``!14`` is metadata providing `location information -`_. In this example, scope is encoded by ``!4``, a -`subprogram descriptor `_. This way the location +`_. In this example, scope is encoded by ``!4``, a +`subprogram descriptor `_. This way the location information attached to the intrinsics indicates that the variable ``X`` is declared at line number 2 at a function level scope in function ``foo``. -- 2.34.1