summaryrefslogtreecommitdiffstats
path: root/lldb/docs/resources
Commit message (Collapse)AuthorAgeFilesLines
* [lldb/CMake] Use LLDB's autodetection logic for libxml2Jonas Devlieghere2020-01-081-0/+2
| | | | | | | Libxml2 is already an optional dependency. It should use the same infrastructure as the other dependencies. Differential revision: https://reviews.llvm.org/D72290
* [lldb/Docs] Describe optional dependencies on build page.Jonas Devlieghere2020-01-061-5/+31
| | | | | | | List the different CMake flags controlling the optional dependencies as per the discussion on the mailing list: http://lists.llvm.org/pipermail/lldb-dev/2020-January/015867.html
* [lldb/Docs] Fix capitalization typo.Jonas Devlieghere2020-01-061-1/+1
| | | | This has been bothering me for way too long.
* [lldb/Docs] Include how to generate the man pageJonas Devlieghere2020-01-031-0/+1
|
* [lldb/CMake] Rename LLDB_DISABLE_PYTHON to LLDB_ENABLE_PYTHONJonas Devlieghere2019-12-131-3/+3
| | | | | | | This matches the naming scheme used by LLVM and all the other optional dependencies in LLDB. Differential revision: https://reviews.llvm.org/D71482
* [lldb/CMake] Rename LLDB_DISABLE_LIBEDIT to LLDB_ENABLE_LIBEDITJonas Devlieghere2019-12-121-2/+2
| | | | | | This matches the naming scheme used by LLVM. Differential revision: https://reviews.llvm.org/D71380
* [lldb/CMake] Rename LLDB_DISABLE_CURSES to LLDB_ENABLE_CURSESJonas Devlieghere2019-12-121-3/+3
| | | | | | This matches the naming scheme used by LLVM. Differential revision: https://reviews.llvm.org/D71377
* Add a "Using LLDB" section to the welcome page of the websiteAdrian Prantl2019-11-191-0/+192
| | | | | | | | | | | | | | | 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
* [Docs] Add reproducer documentationJonas Devlieghere2019-11-181-0/+116
| | | | | | | | This adds a page about LLDB reproducers. It describes how to use the reproducers on the command line and lists some of the known issues/limitations. Differential revision: https://reviews.llvm.org/D70409
* [Docs] Add Python caveats under the development sectionJonas Devlieghere2019-11-182-0/+42
| | | | | | | | | | | This adds a page named Caveats with a section on some of the things to be aware of related to Python. It's a question we've seen more than once pop up and I think it's good to have it documentation on the website. Even though some of it might be useful to users, I still put it under "development" because it requires some understanding of how LLDB is built. Differential revision: https://reviews.llvm.org/D70252
* [LLDB] Make a clear distinction between usage & development docsJonas Devlieghere2019-11-141-21/+0
| | | | | | This renames the "Goals & Status" section to "Project" and the "Resources" section to "Development". To better match this layout I've moved the releases page under "Project".
* Fix typos in docs. NFCDiana Picus2019-11-141-2/+2
|
* lldb/docs: update the lldb-x86_64-debian bot urlPavel Labath2019-11-061-1/+1
| | | | It is on the "stable" master now.
* [Docs] Repurpose 'sources' page as 'contributing'.Jonas Devlieghere2019-10-282-18/+31
| | | | | | The page describing how to get the sources was more about contributing to LLDB than getting the actual source. This patch moves some things around and repurposes this page as a contributing to LLDB landing page.
* [CMake] Remove unused variable LLDB_TEST_CXX_COMPILERJonas Devlieghere2019-10-242-5/+3
| | | | | | | | | | | | | CMake allows you to set a custom CXX compiler for the API test suite. However, this variable is never used, because dotest uses the same compiler to build C and CXX sources. I'm not sure if this variable was added with the intention of supporting a different compiler or if this is just a remnant of old functionality. Given that this hasn't been working for a while, I assume it's safe to remove. Differential revision: https://reviews.llvm.org/D69401
* [Docs] Update testing documentatonJonas Devlieghere2019-10-101-42/+66
| | | | | | Update the test documentation after the directory reorganization. llvm-svn: 374430
* [Docs] Document lldb-instrJonas Devlieghere2019-10-011-0/+40
| | | | | | This adds some information on how to instrument the API classes. llvm-svn: 373277
* [lldb][www] Update bot linksRaphael Isemann2019-09-261-2/+2
| | | | llvm-svn: 372971
* [Docs] Document forwarding arguments with litJonas Devlieghere2019-09-251-0/+8
| | | | | | Explain how to forward arguments to dotest.py from lit. llvm-svn: 372894
* [Documentation] Expand on testing variants.Jonas Devlieghere2019-09-251-7/+54
| | | | | | | | | | | | The testing documentation appears to be from an era when the only kind of tests were the lldbsuite python tests. This patch adds a short description of the unittests and LIT tests and how to run them. Patch by: Lawrence D'Anna Differential revision: https://reviews.llvm.org/D67943 llvm-svn: 372797
* [lldb][CMake] Infer `Clang_DIR` if not passed explicitlyStefan Granitz2019-09-181-7/+7
| | | | | | | | | | | | | | | | | | | | | | Summary: If we only get `LLVM_DIR` and find Clang in the same provided build-tree, automatically infer `Clang_DIR` like this: ``` LLVM_DIR = /path/to/build-llvm/lib/cmake/llvm Clang_DIR = /paht/to/build-llvm/lib/cmake/clang ``` Reviewers: JDevlieghere, jingham, xiaobai, compnerd, labath Reviewed By: JDevlieghere, labath Subscribers: mgorny, lldb-commits, #lldb Tags: #lldb Differential Revision: https://reviews.llvm.org/D65798 llvm-svn: 372210
* [lldb] Remove xcode bot from website listing and fix link to sanitizedRaphael Isemann2019-09-061-2/+1
| | | | llvm-svn: 371172
* use https for llvm.org in the docSylvestre Ledru2019-08-292-9/+9
| | | | llvm-svn: 370303
* Provide a real link to the doc and remove old informationSylvestre Ledru2019-08-291-15/+2
| | | | llvm-svn: 370301
* [dotest] Remove -q (quiet) flag.Jonas Devlieghere2019-08-281-3/+1
| | | | | | | | | | | | | | This patch removes the -q (quiet) flag and changing the default behavior. Currently the flag serves two purposes that are somewhat contradictory, as illustrated by the difference between the argument name (quiet) and the configuration flag (parsable). On the one hand it reduces output, but on the other hand it prints more output, like the result of individual tests. My proposal is to guard the extra output behind the verbose flag and always print the individual test results. Differential revision: https://reviews.llvm.org/D66837 llvm-svn: 370226
* [CMake] Remove LLDB_TEST_USE_CUSTOM_C(XX)_COMPILERJonas Devlieghere2019-08-202-6/+1
| | | | | | | | | | | | Given that LLDB_TEST_USE_CUSTOM_C_COMPILER and LLDB_TEST_C_COMPILER are both set at configuration time, I don't really see the point of having both. This patch simplifies things and uses the custom C/C++ compiler when the variable is set, and uses the default one when it's not set. The variable can be unset by passing -ULLDB_TEST_C_COMPILER to CMake. Differential revision: https://reviews.llvm.org/D66429 llvm-svn: 369435
* [lldb][CMake] Generating Xcode projectsStefan Granitz2019-08-061-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Summary: Print a warning if the wrong cache script is used when generating a Xcode project, because it's too easy to confuse with Apple-lldb-macOS.cmake ``` When building with Xcode, we recommend using the corresponding cache script. If this was a mistake, clean your build directory and re-run CMake with: -C /path/to/llvm-project/lldb/cmake/caches/Apple-lldb-Xcode.cmake See: https://lldb.llvm.org/resources/build.html#cmakegeneratedxcodeproject ``` Also set the generator inside the cache script. Reviewers: JDevlieghere, jingham, clayborg Reviewed By: JDevlieghere Subscribers: mgorny, lldb-commits, #lldb Tags: #lldb Differential Revision: https://reviews.llvm.org/D65797 llvm-svn: 368066
* [lldb][docs] Update landing page for monorepoStefan Granitz2019-08-011-0/+2
| | | | | | | | | | | | | | | | Summary: Following up from D65330, here's an update for the landing page. Reviewers: jryans, clayborg, amccarth, labath Reviewed By: jryans, amccarth, labath Subscribers: arphaman, lldb-commits, #lldb Tags: #lldb Differential Revision: https://reviews.llvm.org/D65437 llvm-svn: 367539
* [lldb][docs] Add CMake version notes for -B flagStefan Granitz2019-07-311-4/+15
| | | | | | The original documentation update was reviewed with D65330 llvm-svn: 367407
* [dotest] Remove multiprocessingJonas Devlieghere2019-07-301-19/+1
| | | | | | | | | | | Now that the Xcode project is removed, I want to focus on dotest as a test framework, and remove its driver capabilities for which we already rely on llvm's lit. Removing multiprocessing is the first step in that direction. Differential revision: https://reviews.llvm.org/D65311 llvm-svn: 367331
* [lldb][docs] Update documentation for monorepo and CMake cachesStefan Granitz2019-07-301-36/+144
| | | | | | | | | | | | | | | | Summary: The lldb build system made good progress in the last months, but documentation was still lacking behind. Here's a patch to catch up. Reviewers: JDevlieghere, jingham, labath, stella.stamenova, teemperor, jryans, kastiglione, xiaobai, compnerd, zturner Reviewed By: labath, stella.stamenova, jryans Subscribers: clayborg, amccarth, friss, lldb-commits, #lldb Tags: #lldb Differential Revision: https://reviews.llvm.org/D65330 llvm-svn: 367302
* [Docs] Remove stale documentationJonas Devlieghere2019-07-221-21/+2
| | | | | | | This removes a stale piece of documentation about building LLDB with the Xcode project. llvm-svn: 366741
* [Docs] Remove stale builderJonas Devlieghere2019-07-031-1/+0
| | | | llvm-svn: 365086
* [Docs] Update documentation build instructions.Jonas Devlieghere2019-07-031-3/+3
| | | | | | | Given that we use Ninja as the build system in the instructions below, we might as well use it to build the documentation as well. llvm-svn: 365083
* [Docs] Unify build instructionsJonas Devlieghere2019-07-031-244/+243
| | | | | | | | | | The current build instructions are structured according the host platform. Instead of having instructions on how to build with CMake repeated for every platform, I unified them, using subsections if things are different for between platforms. I also added the code signing instructions, which were hidden in a text file in the repository. llvm-svn: 365081
* [Docs] Modernize references to macOSJ. Ryan Stinnett2019-05-301-2/+6
| | | | | | | | | | | | | | | | | | | | | | | | Summary: This updates all places in documentation that refer to "Mac OS X", "OS X", etc. to instead use the modern name "macOS" when no specific version number is mentioned. If a specific version is mentioned, this attempts to use the OS name at the time of that version: * Mac OS X for 10.0 - 10.7 * OS X for 10.8 - 10.11 * macOS for 10.12 - present Reviewers: JDevlieghere Subscribers: mgorny, christof, arphaman, cfe-commits, lldb-commits, libcxx-commits, llvm-commits Tags: #clang, #lldb, #libc, #llvm Differential Revision: https://reviews.llvm.org/D62654 llvm-svn: 362113
* [Docs] Remove SVN checkout from LLDB build stepsJonas Devlieghere2019-05-171-51/+0
| | | | | | | | | | | | | | This removes several older paragraphs in the LLDB build steps for Unix systems which suggested checking out various components via SVN. Since there's a separate page about getting the LLDB source which only mentions Git, it seems appropriate to remove this older info from the build docs. Patch by: J. Ryan Stinnett Differential revision: https://reviews.llvm.org/D62041 llvm-svn: 361046
* [CMake] Add error to clarify that lldb requires libcxxStefan Granitz2019-05-151-0/+6
| | | | | | | | | | | | | | | | | | | | | Summary: This adds a specific error message to clarify that lldb requires libcxx when built together with clang on macOS. In addition, the lldb building docs are also updated. Fixes https://bugs.llvm.org/show_bug.cgi?id=41866 Reviewers: sgraenitz, JDevlieghere, EricWF Reviewed By: sgraenitz Subscribers: mgorny, lldb-commits Tags: #lldb Differential Revision: https://reviews.llvm.org/D61877 llvm-svn: 360756
* [Docs] Document lldb-dotestJonas Devlieghere2019-05-151-13/+35
| | | | | | Document the lldb-dotest binary. llvm-svn: 360748
* Rename MacOS X -> macOS where applicable.Adrian Prantl2019-05-141-4/+3
| | | | llvm-svn: 360691
* [Docs] Fix incorrect heading and update titles.Jonas Devlieghere2019-05-082-8/+8
| | | | | | | | 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
* [Docs] Re-order homepage: Download -> Build -> TestJonas Devlieghere2019-05-081-13/+16
| | | | | | I also reformatted some paragraphs to 80 cols. llvm-svn: 360218
* [Docs] Update the CI pageJonas Devlieghere2019-04-241-0/+17
| | | | | | | - Add the Sphinx bot - Add a little more info llvm-svn: 359062
* [Docs] Move external links upJonas Devlieghere2019-04-241-13/+0
| | | | | | | With a duplicate link removed and the API reference moved up, the page didn't make much sense anymore. llvm-svn: 359061
* [Docs] Move API docs to the front pageJonas Devlieghere2019-04-221-6/+0
| | | | | | | | | | | 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
* [Docs] Add more info about building the docsJonas Devlieghere2019-04-191-15/+27
| | | | | | Including the C++ and Python reference. llvm-svn: 358777
* [Docs] Add LLDB botsJonas Devlieghere2019-04-181-0/+20
| | | | llvm-svn: 358693
* Don't abort() in lldb_assert and document why.Adrian Prantl2019-03-291-0/+102
| | | | | | | | rdar://problem/49356014 Differential Revision: https://reviews.llvm.org/D59911 llvm-svn: 357268
* Add LLDB website and documentation in reStructuredText for SphinxJonas Devlieghere2019-01-305-0/+788
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
OpenPOWER on IntegriCloud