Commit 77f8a332 authored by Adrian Prantl's avatar Adrian Prantl
Browse files

Add a "Using LLDB" section to the welcome page of the website 

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.

Differential Revision: https://reviews.llvm.org/D70449
parent 882f23ca

lldb/docs/.htaccess

+2 −1
Original line number Diff line number Diff line 
Redirect 301 /architecture/index.html https://lldb.llvm.org/use/architecture.html

Redirect 301 /architecture/index.html https://lldb.llvm.org/resources/architecture.html

Redirect 301 /cpp_reference/html/index.html https://lldb.llvm.org/cpp_reference/index.html

Redirect 301 /features.html https://lldb.llvm.org/status/features.html

Redirect 301 /formats.html https://lldb.llvm.org/use/formatting.html
@@ -13,3 +13,4 @@ Redirect 301 /varformats.html https://lldb.llvm.org/use/variable.html 
# Sphinx redirects

Redirect 301 /resources/source.html https://lldb.llvm.org/resources/contributing.html

Redirect 301 /resources/download.html https://lldb.llvm.org/status/releases.html

Redirect 301 /use/architecture.html https://lldb.llvm.org/resources/architecture.html

lldb/docs/index.rst

+18 −16
Original line number Diff line number Diff line
@@ -17,21 +17,23 @@ All of the code in the LLDB project is available under the 


.. _"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

GDB there is 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 Python

:ref:`Python Reference <use/python-reference>` is a great starting

point for that.



Compiler Integration Benefits

-----------------------------



LLDB currently converts debug information into clang types so that it can

leverage the clang compiler infrastructure. This allows LLDB to support the

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

leverages the compiler to take care of all ABI details when making functions
@@ -51,7 +53,7 @@ Reusability 
The LLDB debugger APIs are exposed as a C++ object oriented interface in a

shared library. The lldb command line tool links to, and uses this public API.

On macOS the shared library is exposed as a framework named LLDB.framework,

and unix systems expose it as lldb.so. The entire API is also then exposed

and Unix systems expose it as lldb.so. The entire API is also then exposed

through Python script bindings which allow the API to be used within the LLDB

embedded script interpreter, and also in any python script that loads the

lldb.py module in standard python script files. See the Python Reference page
@@ -68,8 +70,8 @@ LLDB is known to work on the following platforms, but ports to new platforms 
are welcome:



* macOS desktop user space debugging for i386 and x86_64

* iOS simulator debugging on i386 and x86_64

* iOS device debugging on ARM and AArch64

* iOS, tvOS, and watchOS simulator debugging on i386 and x86_64

* iOS, tvOS, and watchOS device debugging on ARM and AArch64

* Linux local user-space debugging for i386, x86_64 and PPC64le

* FreeBSD local user-space debugging for i386 and x86_64

* Windows local user-space debugging for i386 (*)
@@ -91,8 +93,8 @@ Note that LLDB generally builds from top-of-trunk using CMake and Ninja. 
Additionally it builds:



* on macOS with a :ref:`generated Xcode project <CMakeGeneratedXcodeProject>`

* on Linux and FreeBSD with clang and libstdc++/libc++

* on NetBSD with GCC/clang and libstdc++/libc++

* on Linux and FreeBSD with Clang and libstdc++/libc++

* on NetBSD with GCC/Clang and libstdc++/libc++

* on Windows with a generated project for VS 2017 or higher



See the :doc:`LLDB Build Page <resources/build>` for build instructions.
@@ -132,13 +134,13 @@ interesting areas to contribute to lldb. 
   use/python-reference

   use/remote

   use/troubleshooting

   use/architecture



.. toctree::

   :hidden:

   :maxdepth: 1

   :caption: Development



   resources/architecture

   resources/contributing

   resources/build

   resources/test

lldb/docs/status/goals.rst

+11 −0
Original line number Diff line number Diff line
@@ -31,3 +31,14 @@ Some more specific goals include: 
* 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.