summaryrefslogtreecommitdiff
path: root/lldb/docs
diff options
context:
space:
mode:
authorMichael Buch <michaelbuch12@gmail.com>2022-10-26 14:40:34 +0100
committerMichael Buch <michaelbuch12@gmail.com>2022-10-28 11:31:15 +0100
commit2a812bdc70c6153f41907db056e348d9b322f01c (patch)
tree565a10102c25eb737f80239df8b04b99cedf1ea8 /lldb/docs
parent14384c96df0dfa6f7c6262d542e1f3a7c00e5d02 (diff)
downloadllvm-2a812bdc70c6153f41907db056e348d9b322f01c.tar.gz
[lldb][Docs][NFC] Fix sphinx warnings/errors for LLDB docs
Ran `ninja docs-lldb-html` and made sure the docs are fixed. Differential Revision: https://reviews.llvm.org/D136766
Diffstat (limited to 'lldb/docs')
-rw-r--r--lldb/docs/resources/build.rst2
-rw-r--r--lldb/docs/resources/test.rst18
-rw-r--r--lldb/docs/use/intel_pt.rst4
3 files changed, 11 insertions, 13 deletions
diff --git a/lldb/docs/resources/build.rst b/lldb/docs/resources/build.rst
index c44bdeee22c8..36b61bcf7899 100644
--- a/lldb/docs/resources/build.rst
+++ b/lldb/docs/resources/build.rst
@@ -99,7 +99,7 @@ Windows
or even write new tests at all, PTVS is an indispensable debugging
extension to VS that enables full editing and debugging support for Python
(including mixed native/managed debugging).
-* `SWIG for Windows <http://www.swig.org/download.html>_`
+* `SWIG for Windows <http://www.swig.org/download.html>`_
The steps outlined here describes how to set up your system and install the
required dependencies such that they can be found when needed during the build
diff --git a/lldb/docs/resources/test.rst b/lldb/docs/resources/test.rst
index 2ecce85fd9db..f91285980f2a 100644
--- a/lldb/docs/resources/test.rst
+++ b/lldb/docs/resources/test.rst
@@ -229,7 +229,7 @@ good testing practices.
time (e.g., C and C++) there is also usually no process necessary to test
the `SBType`-related parts of the API. With those languages it's also
possible to test `SBValue` by running expressions with
- `SBTarget.EvaluateExpression` or the `expect_expr` testing utility.
+ `SBTarget.EvaluateExpression` or the ``expect_expr`` testing utility.
Functionality that always requires a running process is everything that
tests the `SBProcess`, `SBThread`, and `SBFrame` classes. The same is true
@@ -315,27 +315,27 @@ A better way to write the test above would be using LLDB's testing function
self.expect_expr("2 + 2", result_value="0")
**Prefer using specific asserts over the generic assertTrue/assertFalse.**.
- The `self.assertTrue`/`self.assertFalse` functions should always be your
+ The ``self.assertTrue``/``self.assertFalse`` functions should always be your
last option as they give non-descriptive error messages. The test class has
- several expressive asserts such as `self.assertIn` that automatically
+ several expressive asserts such as ``self.assertIn`` that automatically
generate an explanation how the received values differ from the expected
- ones. Check the documentation of Python's `unittest` module to see what
+ ones. Check the documentation of Python's ``unittest`` module to see what
asserts are available. LLDB also has a few custom asserts that are tailored
to our own data types.
+-----------------------------------------------+-----------------------------------------------------------------+
-| **Assert** | **Description** |
+| **Assert** | **Description** |
+-----------------------------------------------+-----------------------------------------------------------------+
-| ``assertSuccess`` | Assert that an ``lldb.SBError`` is in the "success" state. |
+| ``assertSuccess`` | Assert that an ``lldb.SBError`` is in the "success" state. |
+-----------------------------------------------+-----------------------------------------------------------------+
-| ``assertState`` | Assert that two states (``lldb.eState*``) are equal. |
+| ``assertState`` | Assert that two states (``lldb.eState*``) are equal. |
+-----------------------------------------------+-----------------------------------------------------------------+
| ``assertStopReason`` | Assert that two stop reasons (``lldb.eStopReason*``) are equal. |
+-----------------------------------------------+-----------------------------------------------------------------+
If you can't find a specific assert that fits your needs and you fall back
to a generic assert, make sure you put useful information into the assert's
- `msg` argument that helps explain the failure.
+ ``msg`` argument that helps explain the failure.
::
@@ -599,8 +599,6 @@ line to your ``~/.pdbrc``:
alias lldb self.dbg.HandleCommand("%*")
-::
-
Debugging Test Failures on Windows
``````````````````````````````````
diff --git a/lldb/docs/use/intel_pt.rst b/lldb/docs/use/intel_pt.rst
index 3d615e30f99e..694615c83fbc 100644
--- a/lldb/docs/use/intel_pt.rst
+++ b/lldb/docs/use/intel_pt.rst
@@ -39,8 +39,8 @@ decoder library [LibIPT library](https://github.com/intel/libipt).
$ cd libipt-build
$ make
-This will generate a few files in the `<libipt-build>/lib`
-and `<libipt-build>/libipt/include` directories.
+This will generate a few files in the ``<libipt-build>/lib``
+and ``<libipt-build>/libipt/include`` directories.
Configure and build LLDB with Intel PT support