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

74 lines
1.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
.. title:: Welcome to LLDB's documentation!
LLDB
====
LLDB is a next generation, high-performance debugger. It is built as a set of
reusable components which highly leverage existing libraries in the larger LLVM
Project, such as the Clang expression parser and LLVM disassembler.
Don't abort() in lldb_assert and document why. rdar://problem/49356014 Differential Revision: https://reviews.llvm.org/D59911 llvm-svn: 357268
2019-03-30 00:12:27 +08:00
LLDB is the default debugger in Xcode on macOS and supports debugging C,
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
Objective-C and C++ on the desktop and iOS devices and simulator.
All of the code in the LLDB project is available under the standard
`LLVM License <http://llvm.org/docs/DeveloperPolicy.html#copyright-license-and-patents>`__,
an open source "BSD-style" license.
Goals & Status
==============
.. toctree::
:maxdepth: 1
status/about
status/goals
status/features
status/status
status/projects
Use & Extension
===============
.. toctree::
:maxdepth: 1
use/tutorial
use/map
use/formatting
use/variable
use/symbolication
use/symbols
use/python
[Docs] Port python reference page I somehow forgot to port over this page from the old website. Thank you Jim for the heads up! llvm-svn: 360386
2019-05-10 06:14:14 +08:00
use/python-reference
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
use/remote
use/troubleshooting
use/architecture
Resources
=========
.. toctree::
:maxdepth: 1
resources/download
[Docs] Fix incorrect heading and update titles. This patch fixes two incorrect headings in source.rst which caused it to show up on the homepage. I also updated the titles to have more sensible links there. llvm-svn: 360219
2019-05-08 09:51:26 +08:00
resources/source
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
resources/build
resources/test
[Docs] Add LLDB bots llvm-svn: 358693
2019-04-19 01:31:20 +08:00
resources/bots
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
resources/sbapi
[Docs] Move API docs to the front page This moves the links to the C++ and Python API docs up to the main page. As of now the links are still broken [1], but at least this will prevent the additional frustration of searching for the links only to find out they're broken. [1] http://lists.llvm.org/pipermail/lldb-dev/2019-April/014992.html llvm-svn: 358928
2019-04-23 06:41:55 +08:00
API Documentation
=================
[Docs] Differentiate between public and private API On the homepage we should have a clear distinction between the public and private C++ APIs. llvm-svn: 360638
2019-05-14 08:36:05 +08:00
* `Public Python API Reference <https://lldb.llvm.org/python_reference/index.html>`_
* `Public C++ API Reference <https://lldb.llvm.org/cpp_reference/namespacelldb.html>`_
* `Private C++ Reference <https://lldb.llvm.org/cpp_reference/index.html>`_
[Docs] Move API docs to the front page This moves the links to the C++ and Python API docs up to the main page. As of now the links are still broken [1], but at least this will prevent the additional frustration of searching for the links only to find out they're broken. [1] http://lists.llvm.org/pipermail/lldb-dev/2019-April/014992.html llvm-svn: 358928
2019-04-23 06:41:55 +08:00
[Docs] Move external links up With a duplicate link removed and the API reference moved up, the page didn't make much sense anymore. llvm-svn: 359061
2019-04-24 09:48:40 +08:00
External Links
==============
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
[Docs] Move external links up With a duplicate link removed and the API reference moved up, the page didn't make much sense anymore. llvm-svn: 359061
2019-04-24 09:48:40 +08:00
* `Source Code <http://llvm.org/viewvc/llvm-project/lldb/trunk/>`_
* `Code Reviews <https://reviews.llvm.org>`_
* `Bug Reports <https://bugs.llvm.org/>`_