[Lldb-commits] [PATCH] D70449: Add a "Using LLDB" section to the welcome page of the website

[Adrian Prantl via Phabricator via lldb-commits]

aprantl created this revision.
aprantl added reviewers: jingham, JDevlieghere, jasonmolenda, labath, clayborg, friss.
Herald added a subscriber: arphaman.

This is an attempt to feature the user-facing resources more prominently on the LLDB website by calling out the tutorial and the GDB command map wight on the start page.

I also moved the "Why a new debugger" section to the "Goals" subpage. Given that LLDB's first release is almost a decade in the past now, the title is a bit of an anachronism.

Lastly, I moved the Architecture sub-page from "use" to "resources", since end-users do not care about the source code layout.


https://reviews.llvm.org/D70449

Files:
  lldb/docs/index.rst
  lldb/docs/resources/architecture.rst
  lldb/docs/status/goals.rst
  lldb/docs/use/architecture.rst


Index: lldb/docs/status/goals.rst
===================================================================
--- lldb/docs/status/goals.rst
+++ lldb/docs/status/goals.rst
@@ -31,3 +31,14 @@
 * Great support for C, Objective-C and C++
 * Retargetable to support multiple platforms
 * Provide a base for debugger research and other innovation
+
+Why a New Debugger?
+-------------------
+
+In order to achieve our goals we decided to start with a fresh architecture
+that would support modern multi-threaded programs, handle debugging symbols in
+an efficient manner, use compiler based code knowledge and have plug-in support
+for functionality and extensions. Additionally we want the debugger
+capabilities to be available to other analysis tools, be they scripts or
+compiled programs, without requiring them to be GPL.
+
Index: lldb/docs/index.rst
===================================================================
--- lldb/docs/index.rst
+++ lldb/docs/index.rst
@@ -17,20 +17,22 @@
 
 .. _"Apache 2.0 License with LLVM exceptions": https://llvm.org/docs/DeveloperPolicy.html#new-llvm-project-license-framework
 
-Why a New Debugger?
--------------------
+Using LLDB
+----------
 
-In order to achieve our goals we decided to start with a fresh architecture
-that would support modern multi-threaded programs, handle debugging symbols in
-an efficient manner, use compiler based code knowledge and have plug-in support
-for functionality and extensions. Additionally we want the debugger
-capabilities to be available to other analysis tools, be they scripts or
-compiled programs, without requiring them to be GPL.
+For an introduction into the LLDB command language, head over to the
+:ref:`LLDB Tutorial <use/tutorial>`. For users already familiar with
+other debuggers there is also a cheat sheet listing common tasks and
+their LLDB equivalent in the :ref:`GDB to LLDB command map <use/map>`.
+
+There are also multiple resources on how to script LLDB using Pythonl
+:ref:`Python Reference <use/python-reference>` is a great staring
+point for that.
 
 Compiler Integration Benefits
 -----------------------------
 
-LLDB currently converts debug information into clang types so that it can
+LLDB converts debug information into Clang types so that it can
 leverage the clang compiler infrastructure. This allows LLDB to support the
 latest C, C++, Objective-C and Objective-C++ language features and runtimes in
 expressions without having to reimplement any of this functionality. It also
@@ -132,13 +134,13 @@
    use/python-reference
    use/remote
    use/troubleshooting
-   use/architecture
 
 .. toctree::
    :hidden:
    :maxdepth: 1
    :caption: Development
 
+   resources/architecture
    resources/contributing
    resources/build
    resources/test


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D70449.230086.patch
Type: text/x-patch
Size: 2767 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/lldb-commits/attachments/20191119/7bac3b5d/attachment.bin>