Lines Matching +full:docs +full:- +full:lldb +full:- +full:html
1 .. title:: LLDB Homepage
3 The LLDB Debugger
6 Welcome to the LLDB documentation!
8 LLDB is a next generation, high-performance debugger. It is built as a set of
13 LLDB is the default debugger in Xcode on macOS and supports debugging C,
14 Objective-C and C++ on the desktop and iOS devices and simulator.
16 All of the code in the LLDB project is available under the
19 .. _"Apache 2.0 License with LLVM exceptions": https://llvm.org/docs/DeveloperPolicy.html#new-llvm-project-license-framework
21 Using LLDB
22 ----------
24 For an introduction into the LLDB command language, head over to the `LLDB
25 Tutorial <https://lldb.llvm.org/use/tutorial.html>`_. For users already familiar
26 with GDB there is a cheat sheet listing common tasks and their LLDB equivalent
27 in the `GDB to LLDB command map <https://lldb.llvm.org/use/map.html>`_.
29 There are also multiple resources on how to script LLDB using Python: the
30 :doc:`use/python-reference` is a great starting point for that.
33 -----------------------------
35 LLDB converts debug information into Clang types so that it can
36 leverage the Clang compiler infrastructure. This allows LLDB to support the
37 latest C, C++, Objective-C and Objective-C++ language features and runtimes in
45 - Up to date language support for C, C++, Objective-C
46 - Multi-line expressions that can declare local variables and types
47 - Utilize the JIT for expressions when supported
48 - Evaluate expression Intermediate Representation (IR) when JIT can't be used
51 -----------
53 The LLDB debugger APIs are exposed as a C++ object oriented interface in a
54 shared library. The lldb command line tool links to, and uses this public API.
55 On macOS the shared library is exposed as a framework named LLDB.framework,
56 and Unix systems expose it as lldb.so. The entire API is also then exposed
57 through Python script bindings which allow the API to be used within the LLDB
59 lldb.py module in standard python script files. See the Python Reference page
60 for more details on how and where Python can be used with the LLDB API.
62 Sharing the LLDB API allows LLDB to not only be used for debugging, but also
67 ----------------
69 LLDB is known to work on the following platforms, but ports to new platforms
75 * Linux user-space debugging for i386, x86_64, ARM, AArch64, PPC64le, s390x
76 * FreeBSD user-space debugging for i386, x86_64, ARM, AArch64, MIPS64, PPC
77 * NetBSD user-space debugging for i386 and x86_64
78 * Windows user-space debugging for i386, x86_64, ARM and AArch64 (*)
87 * `RISC-V <https://github.com/llvm/llvm-project/issues/55383>`_
88 * `LoongArch <https://github.com/llvm/llvm-project/issues/112693>`_
91 ------------
93 Check out the LLVM source-tree with git and find the sources in the `lldb`
98 $ git clone https://github.com/llvm/llvm-project.git
100 Note that LLDB generally builds from top-of-trunk using CMake and Ninja.
108 See the :doc:`LLDB Build Page <resources/build>` for build instructions.
110 Discussions about LLDB should go to the `LLDB forum
111 <https://discourse.llvm.org/c/subprojects/lldb>`__ or the ``lldb`` channel on
115 `LLVM contribution process <https://llvm.org/docs/Contributing.html>`__. Commit
116 messages are automatically sent to the `lldb-commits
117 <http://lists.llvm.org/mailman/listinfo/lldb-commits>`__ mailing list.
120 interesting areas to contribute to lldb.
125 :caption: Using LLDB
136 use/aarch64-linux
140 Man Page <man/lldb>
145 :caption: Scripting LLDB
148 use/python-reference
156 :caption: Developing LLDB
162 resources/qemu-testing
175 Public C++ API <https://lldb.llvm.org/cpp_reference/namespacelldb.html>
176 Private C++ API <https://lldb.llvm.org/cpp_reference/index.html>
183 Source Code <https://github.com/llvm/llvm-project>
184 Releases <https://github.com/llvm/llvm-project/releases>
186 Discussion Forums <https://discourse.llvm.org/c/subprojects/lldb/8>
187 Developer Policy <https://llvm.org/docs/DeveloperPolicy.html>
188 Bug Reports <https://github.com/llvm/llvm-project/issues?q=is%3Aissue+label%3Alldb+is%3Aopen>
189 Code Reviews <https://github.com/llvm/llvm-project/pulls?q=is%3Apr+label%3Alldb+is%3Aopen>