maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/lldb/docs/status/status.rst

66 lines
4.6 KiB
ReStructuredText
Raw Normal View History

Add LLDB website and documentation in reStructuredText for Sphinx 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
2019-01-31 02:51:40 +08:00
Status
======
macOS
-----
LLDB has matured a lot in the last year and can be used for C, C++ and
Objective-C development for x86_64, i386 and ARM debugging. The entire public
Rename MacOS X -> macOS where applicable. llvm-svn: 360691
2019-05-15 00:37:43 +08:00
API is exposed though a framework on macOS which is used by Xcode, the lldb
Add LLDB website and documentation in reStructuredText for Sphinx 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
2019-01-31 02:51:40 +08:00
command line tool, and can also be used by Python. The entire public API is
exposed through script bridging which allows LLDB to use an embedded Python
script interpreter, as well as having a Python module named "lldb" which can be
used from Python on the command line. This allows debug sessions to be
scripted. It also allows powerful debugging actions to be created and attached
to a variety of debugging workflows.
Linux
-----
LLDB is improving on Linux. While the debugserver has not been ported (to
enable remote debugging) Linux is nearing feature completeness with Darwin to
debug x86_64 programs, and is partially working with i386 programs. ARM
architectures on Linux are untested. For more details, see the Features by OS
section below.
FreeBSD
-------
LLDB on FreeBSD lags behind the Linux implementation but is improving rapidly.
For more details, see the Features by OS section below.
Windows
-------
LLDB on Windows is still under development, but already useful for i386
programs (x86_64 untested) built with DWARF debug information, including
postmortem analysis of minidumps. For more details, see the Features by OS
section below.
Features Matrix
---------------
+--------------------------------+------------+-------------------------+--------------------------------------+----------------------+
Rename MacOS X -> macOS where applicable. llvm-svn: 360691
2019-05-15 00:37:43 +08:00
| Feature | FreeBSD | Linux | macOS (i386/x86_64 and ARM/Thumb) | Windows (i386) |
Add LLDB website and documentation in reStructuredText for Sphinx 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
2019-01-31 02:51:40 +08:00
| | (x86_64) | (x86_64 and PPC64le) | | |
+================================+============+=========================+======================================+======================+
| Backtracing | OK | OK | OK | OK |
+--------------------------------+------------+-------------------------+--------------------------------------+----------------------+
| Breakpoints | OK | OK | OK | OK |
+--------------------------------+------------+-------------------------+--------------------------------------+----------------------+
| C++11: | OK | OK | OK | Unknown |
+--------------------------------+------------+-------------------------+--------------------------------------+----------------------+
| Commandline lldb tool | OK | OK | OK | OK |
+--------------------------------+------------+-------------------------+--------------------------------------+----------------------+
| Core file debugging | OK (ELF) | OK (ELF) | OK (MachO) | OK (Minidump) |
+--------------------------------+------------+-------------------------+--------------------------------------+----------------------+
| Debugserver (remote debugging) | Not ported | Not ported | OK | Not ported |
+--------------------------------+------------+-------------------------+--------------------------------------+----------------------+
| Disassembly | OK | OK | OK | OK |
+--------------------------------+------------+-------------------------+--------------------------------------+----------------------+
| Expression evaluation | Unknown | Works with some bugs | OK | Works with some bugs |
+--------------------------------+------------+-------------------------+--------------------------------------+----------------------+
| JIT debugging | Unknown | Symbolic debugging only | Untested | No |
+--------------------------------+------------+-------------------------+--------------------------------------+----------------------+
| Objective-C 2.0: | Unknown | Not applicable | OK | Not applicable |
+--------------------------------+------------+-------------------------+--------------------------------------+----------------------+