The current LLDB website is written in HTML which is hard to maintain. We have quite a bit of HTML code checked in which can make it hard to differentiate between documentation written by us and documentation generated by a tool. In line with the other LLVM projects, I propose generating the documentation with Sphix. I think text/rst files provide a lower barrier for new or casual contributors to fix or update. This patch adds a copy of the LLDB website and documentation in reStructuredText. It also adds a new ninja target `docs-lldb-html` when -DLLVM_ENABLE_SPHINX:BOOL is enabled. This is the first step in having the website and documentation being generated from the repository, rather than having the output checked-in under the www folder. During the hopefully short transition period, please also update the reStructuredText files when modifying the website. Differential revision: https://reviews.llvm.org/D55376 llvm-svn: 352644
19 lines
1.2 KiB
ReStructuredText
19 lines
1.2 KiB
ReStructuredText
Features
|
|
========
|
|
|
|
LLDB supports a broad variety of basic debugging features such as reading DWARF, supporting step, next, finish, backtraces, etc. Some more interested bits are:
|
|
|
|
* Plug-in architecture for portability and extensibility:
|
|
|
|
* Object file parsers for executable file formats. Support currently includes Mach-O (32 and 64-bit) & ELF (32-bit).
|
|
* Object container parsers to extract object files contained within a file. Support currently includes universal Mach-O files & BSD Archives.
|
|
* Debug symbol file parsers to incrementally extract debug information from object files. Support currently includes DWARF & Mach-O symbol tables.
|
|
* Symbol vendor plug-ins collect data from a variety of different sources for an executable object.
|
|
* Disassembly plug-ins for each architecture. Support currently includes an LLVM disassembler for i386, x86-64 , ARM/Thumb, and PPC64le
|
|
* Debugger plug-ins implement the host and target specific functions required to debug.
|
|
|
|
* SWIG-generated script bridging allows Python to access and control the public API of the debugger library.
|
|
* A remote protocol server, debugserver, implements Mac OS X debugging on i386 and x86-64.
|
|
* A command line debugger - the lldb executable itself.
|
|
* A framework API to the library.
|