From 46d318c2b5103956006e324ffea7fcf4d7140251 Mon Sep 17 00:00:00 2001 From: Jonas Devlieghere Date: Wed, 8 May 2019 01:51:26 +0000 Subject: [PATCH] [Docs] Fix incorrect heading and update titles. This patch fixes two incorrect headings in source.rst which caused it to show up on the homepage. I also updated the titles to have more sensible links there. llvm-svn: 360219 --- lldb/docs/index.rst | 2 +- lldb/docs/resources/download.rst | 2 +- lldb/docs/resources/source.rst | 14 +++++++------- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/lldb/docs/index.rst b/lldb/docs/index.rst index c01c7ad447d6..69f7a07c5b68 100644 --- a/lldb/docs/index.rst +++ b/lldb/docs/index.rst @@ -51,9 +51,9 @@ Resources :maxdepth: 1 resources/download + resources/source resources/build resources/test - resources/source resources/bots resources/sbapi diff --git a/lldb/docs/resources/download.rst b/lldb/docs/resources/download.rst index 37fcb35f06ff..ccc0caa1b441 100644 --- a/lldb/docs/resources/download.rst +++ b/lldb/docs/resources/download.rst @@ -1,4 +1,4 @@ -Download +Releases ======== Nightly Builds diff --git a/lldb/docs/resources/source.rst b/lldb/docs/resources/source.rst index 8ef69b04b23a..11856380a981 100644 --- a/lldb/docs/resources/source.rst +++ b/lldb/docs/resources/source.rst @@ -1,5 +1,5 @@ -Checking out LLDB Sources -========================= +Getting the Sources +=================== Refer to the `LLVM Getting Started Guide `_ @@ -33,7 +33,7 @@ Clang in these locations. Refer to the `Build Instructions particular platform / build system combination. Contributing to LLDB -==================== +-------------------- Please refer to the `LLVM Developer Policy `_ for information about @@ -48,7 +48,7 @@ policy. Error handling and use of assertions in LLDB -============================================ +-------------------------------------------- Contrary to Clang, which is typically a short-lived process, LLDB debuggers stay up and running for a long time, often serving multiple @@ -65,7 +65,7 @@ rules of thumb: used. Functions that may fail should return their result using these wrapper types instead of using a bool to indicate success. Returning a default value when an error occurred is also discouraged. - + * Assertions. Assertions (from `assert.h`) should be used liberally to assert internal consistency. Assertions shall **never** be used to detect invalid user input, such as malformed DWARF. An @@ -75,11 +75,11 @@ rules of thumb: checks in an assertion may be more expensive than otherwise permissible. In combination with the LLDB test suite, assertions are what allows us to refactor and evolve the LLDB code base. - + * Logging. LLDB provides a very rich logging API. When recoverable errors cannot reasonably by surfaced to the end user, the error may be written to a topical log channel. - + * Soft assertions. LLDB provides `lldb_assert()` as a soft alternative to cover the middle ground of situations that indicate a recoverable bug in LLDB. In a Debug configuration `lldb_assert()`